diff --git a/branch/main/api_info_module.html b/branch/main/api_info_module.html index ad75624..a22cb27 100644 --- a/branch/main/api_info_module.html +++ b/branch/main/api_info_module.html @@ -287,13 +287,27 @@ see
Whether to include read-only fields.
+By default, they are not returned.
+Choices:
+false
← (default)
true
RouterOS user password.
8729
for the HTTPS API.
tls
aliases: ssl
@@ -489,7 +503,7 @@ seeRouterOS login user.
validate_cert_hostname
boolean
added in community.routeros 1.2.0
@@ -523,7 +537,7 @@ seevalidate_certs
boolean
added in community.routeros 1.2.0
diff --git a/branch/main/api_modify_module.html b/branch/main/api_modify_module.html index 6a03e31..82b9435 100644 --- a/branch/main/api_modify_module.html +++ b/branch/main/api_modify_module.html @@ -89,6 +89,7 @@If remove
, they are removed. If at least one cannot be removed, the module will fail.
If remove_as_much_as_possible
, all that can be removed will be removed. The ones that cannot be removed will be kept.
Note that remove
and remove_as_much_as_possible
do not apply to write-only fields.
Choices:
"ignore"
← (default)
How to handle values passed in for read-only fields.
+If ignore
, they are not passed to the API.
If validate
, the values are not passed for creation, and for updating they are compared to the value returned for the object. If they differ, the module fails.
If error
, the module will fail if read-only fields are provided.
Choices:
+"ignore"
"validate"
"error"
← (default)
How to handle values passed in for write-only fields.
+If create_only
, they are passed on creation, and ignored for updating.
If always_update
, they are always passed to the API. This means that if such a value is present, the module will always result in changed
since there is no way to validate whether the value actually changed.
If error
, the module will fail if write-only fields are provided.
Choices:
+"create_only"
← (default)
"always_update"
"error"
Note
+If write-only fields are present in the path, the module is not idempotent in a strict sense, since it is not able to verify the current value of these fields. The behavior the module should assume can be controlled with the handle_write_only
option.
See also
---
- name: Setup DHCP server networks
# Ensures that we have exactly two DHCP server networks (in the specified order)
@@ -631,7 +677,7 @@ see
-Return Values
+Return Values
Common return values are documented here, the following are the fields unique to this module: