diff --git a/docs/index.md b/docs/index.md index 233fff83..e186e9e3 100644 --- a/docs/index.md +++ b/docs/index.md @@ -3,8 +3,15 @@ page_title: "Provider: RouterOS" description: |- Yet another Mikrotik provider for managing Mikrotik RouterOS devices. --- +# ⚠️ Warning! ⚠️ +The GitHub repository for this provider is switched to archive mode, since the main changes have been transferred to the parent repository and all current development will take place in it. **Please use TF provider ["GNewbury1/routeros"](https://registry.terraform.io/providers/GNewbury1/routeros/latest).** -# ROUTEROS Provider +Backward compatibility for TF resources is [provided](https://github.com/GNewbury1/terraform-provider-routeros/commit/5ed67a7e78cbf167320e2092c7c276e7410041bd) (routeros_firewall_\*, routeros_bridge, routeros_vlan, etc.). + + +--- + +### ROUTEROS Provider The provider supports TLS connection to Mikrotik devices and uses the classic API or modern REST for this. @@ -14,17 +21,17 @@ N.B. If you don't specify a URL scheme, then the default connection will be TLS > If you are using this provider on x86 arch, you need to be prepared for the fact that you will not be able to set values equal to 4294967295 because an integer overflow occurs. -## Requirements +### Requirements * RouterOS v6.45.2+ (For access via classic API) * RouterOS v7.1beta4+ (For access via REST API) -## Thanks to +### Thanks to [@GNewbury1](https://github.com/GNewbury1) https://github.com/GNewbury1/terraform-provider-routeros [@ddelnano](https://github.com/ddelnano) https://github.com/ddelnano/terraform-provider-mikrotik -## Example Usage +### Example Usage ```terraform terraform { required_providers { @@ -50,9 +57,9 @@ resource "routeros_gre" "gre_hq" { ``` -## Schema +### Schema -### Required +#### Required - `hosturl` (String) URL of the MikroTik router, default is TLS connection to REST. * API: api[s]://host[:port] @@ -70,7 +77,7 @@ resource "routeros_gre" "gre_hq" { export ROS_USERNAME=admin or export MIKROTIK_USER=admin -### Optional +#### Optional - `ca_certificate` (String) Path to MikroTik's certificate authority file. - `insecure` (Boolean) Whether to verify the SSL certificate or not.