PEM formatted file that contains a CA certificate to be used for certificate validation.
-See also validate_cert_hostname. Only used when tls=true and validate_certs=true.
+See also validate_cert_hostname. Only used when tls=true and validate_certs=true.
Use the specified encoding when communicating with the RouterOS device.
-Default is ASCII. Note that UTF-8 requires librouteros 3.2.1 or newer.
Default is ASCII. Note that UTF-8 requires librouteros 3.2.1 or newer.
Default: "ASCII"
boolean
added in community.routeros 2.4.0
-Set to true to connect without a certificate when tls=true.
See also validate_certs.
-Note: this forces the use of anonymous Diffie-Hellman (ADH) ciphers. The protocol is susceptible to Man-in-the-Middle attacks, because the keys used in the exchange are not authenticated. Instead of simply connecting without a certificate to “make things work” have a look at validate_certs and ca_path.
+Set to true to connect without a certificate when tls=true.
See also validate_certs.
Note: this forces the use of anonymous Diffie-Hellman (ADH) ciphers. The protocol is susceptible to Man-in-the-Middle attacks, because the keys used in the exchange are not authenticated. Instead of simply connecting without a certificate to “make things work” have a look at validate_certs and ca_path.
Choices:
gather_subset
list / elements=string
When supplied, this argument will restrict the facts collected to a given subset. Possible values for this argument include all, hardware, interfaces, and routing.
Can specify a list of values to include a larger subset. Values can also be used with an initial ! to specify that a specific subset should not be collected.
When supplied, this argument will restrict the facts collected to a given subset. Possible values for this argument include all, hardware, interfaces, and routing.
Can specify a list of values to include a larger subset. Values can also be used with an initial ! to specify that a specific subset should not be collected.
Default: ["all"]
port
integer
RouterOS api port. If tls is set, port will apply to TLS/SSL connection.
-Defaults are 8728 for the HTTP API, and 8729 for the HTTPS API.
RouterOS api port. If tls is set, port will apply to TLS/SSL connection.
Defaults are 8728 for the HTTP API, and 8729 for the HTTPS API.
Set to true to validate hostnames in certificates.
See also validate_certs. Only used when tls=true and validate_certs=true.
+Set to true to validate hostnames in certificates.
See also validate_certs. Only used when tls=true and validate_certs=true.
Choices:
Set to false to skip validation of TLS certificates.
See also validate_cert_hostname. Only used when tls=true.
-Note: instead of simply deactivating certificate validations to “make things work”, please consider creating your own CA certificate and using it to sign certificates used for your router. You can tell the module about your CA certificate with the ca_path option.
+Set to false to skip validation of TLS certificates.
See also validate_cert_hostname. Only used when tls=true.
Note: instead of simply deactivating certificate validations to “make things work”, please consider creating your own CA certificate and using it to sign certificates used for your router. You can tell the module about your CA certificate with the ca_path option.
Choices:
All IPv4 addresses configured on the device.
-Returned: gather_subset contains interfaces
Returned: gather_subset contains interfaces
All IPv6 addresses configured on the device.
-Returned: gather_subset contains interfaces
Returned: gather_subset contains interfaces
The CPU architecture of the device.
-Returned: gather_subset contains default
Returned: gather_subset contains default
A dictionary with BGP instance information.
-Returned: gather_subset contains routing
Returned: gather_subset contains routing
A dictionary with BGP peer information.
-Returned: gather_subset contains routing
Returned: gather_subset contains routing
A dictionary with BGP vpnv4 route information.
-Returned: gather_subset contains routing
Returned: gather_subset contains routing
Current CPU load.
-Returned: gather_subset contains default
Returned: gather_subset contains default
The configured hostname of the device.
-Returned: gather_subset contains default
Returned: gather_subset contains default
A hash of all interfaces running on the system.
-Returned: gather_subset contains interfaces
Returned: gather_subset contains interfaces
The available free memory on the remote device in MiB.
-Returned: gather_subset contains hardware
Returned: gather_subset contains hardware
The total memory on the remote device in MiB.
-Returned: gather_subset contains hardware
Returned: gather_subset contains hardware
The model name returned from the device.
-Returned: gather_subset contains default
Returned: gather_subset contains default
The list of neighbors from the remote device.
-Returned: gather_subset contains interfaces
Returned: gather_subset contains interfaces
A dictionary with OSPF instances.
-Returned: gather_subset contains routing
Returned: gather_subset contains routing
A dictionary with OSPF neighbors.
-Returned: gather_subset contains routing
Returned: gather_subset contains routing
A dictionary for routes in all routing tables.
-Returned: gather_subset contains routing
Returned: gather_subset contains routing
The serial number of the remote device.
-Returned: gather_subset contains default
Returned: gather_subset contains default
The available disk space on the remote device in MiB.
-Returned: gather_subset contains hardware
Returned: gather_subset contains hardware
The total disk space on the remote device in MiB.
-Returned: gather_subset contains hardware
Returned: gather_subset contains hardware
The uptime of the device.
-Returned: gather_subset contains default
Returned: gather_subset contains default
The operating system version running on the remote device.
-Returned: gather_subset contains default
Returned: gather_subset contains default
boolean
Whether to allow that no match is found.
-If not specified, this value is induced from whether require_matches_min is 0 or larger.
+If not specified, this value is induced from whether require_matches_min is 0 or larger.
Choices:
false
PEM formatted file that contains a CA certificate to be used for certificate validation.
-See also validate_cert_hostname. Only used when tls=true and validate_certs=true.
+See also validate_cert_hostname. Only used when tls=true and validate_certs=true.
Use the specified encoding when communicating with the RouterOS device.
-Default is ASCII. Note that UTF-8 requires librouteros 3.2.1 or newer.
Default is ASCII. Note that UTF-8 requires librouteros 3.2.1 or newer.
Default: "ASCII"
dictionary / required
Fields to search for.
-The module will only consider entries in the given path that match all fields provided here.
-Use YAML ~, or prepend keys with !, to specify an unset value.
The module will only consider entries in the given path that match all fields provided here.
Use YAML ~, or prepend keys with !, to specify an unset value.
Note that if the dictionary specified here is empty, every entry in the path will be matched.
boolean
added in community.routeros 2.4.0
-Set to true to connect without a certificate when tls=true.
See also validate_certs.
-Note: this forces the use of anonymous Diffie-Hellman (ADH) ciphers. The protocol is susceptible to Man-in-the-Middle attacks, because the keys used in the exchange are not authenticated. Instead of simply connecting without a certificate to “make things work” have a look at validate_certs and ca_path.
+Set to true to connect without a certificate when tls=true.
See also validate_certs.
Note: this forces the use of anonymous Diffie-Hellman (ADH) ciphers. The protocol is susceptible to Man-in-the-Middle attacks, because the keys used in the exchange are not authenticated. Instead of simply connecting without a certificate to “make things work” have a look at validate_certs and ca_path.
Choices:
Path to query.
-An example value is ip address. This is equivalent to running /ip address in the RouterOS CLI.
An example value is ip address. This is equivalent to running /ip address in the RouterOS CLI.
RouterOS api port. If tls is set, port will apply to TLS/SSL connection.
-Defaults are 8728 for the HTTP API, and 8729 for the HTTPS API.
RouterOS api port. If tls is set, port will apply to TLS/SSL connection.
Defaults are 8728 for the HTTP API, and 8729 for the HTTPS API.
Set to true to validate hostnames in certificates.
See also validate_certs. Only used when tls=true and validate_certs=true.
+Set to true to validate hostnames in certificates.
See also validate_certs. Only used when tls=true and validate_certs=true.
Choices:
Set to false to skip validation of TLS certificates.
See also validate_cert_hostname. Only used when tls=true.
-Note: instead of simply deactivating certificate validations to “make things work”, please consider creating your own CA certificate and using it to sign certificates used for your router. You can tell the module about your CA certificate with the ca_path option.
+Set to false to skip validation of TLS certificates.
See also validate_cert_hostname. Only used when tls=true.
Note: instead of simply deactivating certificate validations to “make things work”, please consider creating your own CA certificate and using it to sign certificates used for your router. You can tell the module about your CA certificate with the ca_path option.
Choices:
values
dictionary / required
On all entries matching the conditions in find, set the keys of this option to the values specified here.
-Use YAML ~, or prepend keys with !, to specify to unset a value.
On all entries matching the conditions in find, set the keys of this option to the values specified here.
Use YAML ~, or prepend keys with !, to specify to unset a value.
Note
If you want to change values based on their old values (like change all comments ‘foo’ to ‘bar’) and make sure that there are at least N such values, you can use require_matches_min=N together with allow_no_matches=true. This will make the module fail if there are less than N such entries, but not if there is no match. The latter case is needed for idempotency of the task: once the values have been changed, there should be no further match.
If you want to change values based on their old values (like change all comments ‘foo’ to ‘bar’) and make sure that there are at least N such values, you can use require_matches_min=N together with allow_no_matches=true. This will make the module fail if there are less than N such entries, but not if there is no match. The latter case is needed for idempotency of the task: once the values have been changed, there should be no further match.
match_count
integer
The number of entries that matched the criteria in find.
+Allows to retrieve information for a path using the API.
This can be used to backup a path to restore it with the community.routeros.api_modify module.
Entries are normalized, dynamic and builtin entries are not returned. Use the handle_disabled and hide_defaults options to control normalization, the include_dynamic and include_builtin options to also return dynamic resp. builtin entries, and use unfiltered to return all fields including counters.
Entries are normalized, dynamic and builtin entries are not returned. Use the handle_disabled and hide_defaults options to control normalization, the include_dynamic and include_builtin options to also return dynamic resp. builtin entries, and use unfiltered to return all fields including counters.
Note that this module is still heavily in development, and only supports some paths. If you want to support new paths, or think you found problems with existing paths, please first create an issue in the community.routeros Issue Tracker.
PEM formatted file that contains a CA certificate to be used for certificate validation.
-See also validate_cert_hostname. Only used when tls=true and validate_certs=true.
+See also validate_cert_hostname. Only used when tls=true and validate_certs=true.
Use the specified encoding when communicating with the RouterOS device.
-Default is ASCII. Note that UTF-8 requires librouteros 3.2.1 or newer.
Default is ASCII. Note that UTF-8 requires librouteros 3.2.1 or newer.
Default: "ASCII"
boolean
added in community.routeros 2.4.0
-Set to true to connect without a certificate when tls=true.
See also validate_certs.
-Note: this forces the use of anonymous Diffie-Hellman (ADH) ciphers. The protocol is susceptible to Man-in-the-Middle attacks, because the keys used in the exchange are not authenticated. Instead of simply connecting without a certificate to “make things work” have a look at validate_certs and ca_path.
+Set to true to connect without a certificate when tls=true.
See also validate_certs.
Note: this forces the use of anonymous Diffie-Hellman (ADH) ciphers. The protocol is susceptible to Man-in-the-Middle attacks, because the keys used in the exchange are not authenticated. Instead of simply connecting without a certificate to “make things work” have a look at validate_certs and ca_path.
Choices:
How to handle unset values.
-exclamation prepends the keys with ! in the output with value null.
null-value uses the regular key with value null.
omit omits these values from the result.
exclamation prepends the keys with ! in the output with value null.
null-value uses the regular key with value null.
omit omits these values from the result.
Choices:
"exclamation" ← (default)
Whether to include builtin values.
By default, they are not returned, and the builtin keys are omitted.
If set to true, they are returned as well, and the builtin keys are returned as well.
If set to true, they are returned as well, and the builtin keys are returned as well.
Choices:
false ← (default)
Whether to include dynamic values.
By default, they are not returned, and the dynamic keys are omitted.
If set to true, they are returned as well, and the dynamic keys are returned as well.
If set to true, they are returned as well, and the dynamic keys are returned as well.
Choices:
Path to query.
-An example value is ip address. This is equivalent to running /ip address print in the RouterOS CLI.
An example value is ip address. This is equivalent to running /ip address print in the RouterOS CLI.
Choices:
port
integer
RouterOS api port. If tls is set, port will apply to TLS/SSL connection.
-Defaults are 8728 for the HTTP API, and 8729 for the HTTPS API.
RouterOS api port. If tls is set, port will apply to TLS/SSL connection.
Defaults are 8728 for the HTTP API, and 8729 for the HTTPS API.
Set to true to validate hostnames in certificates.
See also validate_certs. Only used when tls=true and validate_certs=true.
+Set to true to validate hostnames in certificates.
See also validate_certs. Only used when tls=true and validate_certs=true.
Choices:
Set to false to skip validation of TLS certificates.
See also validate_cert_hostname. Only used when tls=true.
-Note: instead of simply deactivating certificate validations to “make things work”, please consider creating your own CA certificate and using it to sign certificates used for your router. You can tell the module about your CA certificate with the ca_path option.
+Set to false to skip validation of TLS certificates.
See also validate_cert_hostname. Only used when tls=true.
Note: instead of simply deactivating certificate validations to “make things work”, please consider creating your own CA certificate and using it to sign certificates used for your router. You can tell the module about your CA certificate with the ca_path option.
Choices:
false
PEM formatted file that contains a CA certificate to be used for certificate validation.
-See also validate_cert_hostname. Only used when tls=true and validate_certs=true.
+See also validate_cert_hostname. Only used when tls=true and validate_certs=true.
Use the specified encoding when communicating with the RouterOS device.
-Default is ASCII. Note that UTF-8 requires librouteros 3.2.1 or newer.
Default is ASCII. Note that UTF-8 requires librouteros 3.2.1 or newer.
Default: "ASCII"
ensure_order
boolean
Whether to ensure the same order of the config as present in data.
-Requires handle_absent_entries=remove.
+Whether to ensure the same order of the config as present in data.
Requires handle_absent_entries=remove.
Choices:
Set to true to connect without a certificate when tls=true.
See also validate_certs.
-Note: this forces the use of anonymous Diffie-Hellman (ADH) ciphers. The protocol is susceptible to Man-in-the-Middle attacks, because the keys used in the exchange are not authenticated. Instead of simply connecting without a certificate to “make things work” have a look at validate_certs and ca_path.
+Set to true to connect without a certificate when tls=true.
See also validate_certs.
Note: this forces the use of anonymous Diffie-Hellman (ADH) ciphers. The protocol is susceptible to Man-in-the-Middle attacks, because the keys used in the exchange are not authenticated. Instead of simply connecting without a certificate to “make things work” have a look at validate_certs and ca_path.
Choices:
handle_absent_entries
string
How to handle entries that are present in the current config, but not in data.
-ignore ignores them.
remove removes them.
How to handle entries that are present in the current config, but not in data.
ignore ignores them.
remove removes them.
Choices:
handle_entries_content
string
For a single entry in data, this describes how to handle fields that are not mentioned in that entry, but appear in the actual config.
-If ignore, they are not modified.
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.
For a single entry in data, this describes how to handle fields that are not mentioned in that entry, but appear in the actual config.
If ignore, they are not modified.
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.
Choices:
Path to query.
-An example value is ip address. This is equivalent to running modification commands in /ip address in the RouterOS CLI.
An example value is ip address. This is equivalent to running modification commands in /ip address in the RouterOS CLI.
Choices:
port
integer
RouterOS api port. If tls is set, port will apply to TLS/SSL connection.
-Defaults are 8728 for the HTTP API, and 8729 for the HTTPS API.
RouterOS api port. If tls is set, port will apply to TLS/SSL connection.
Defaults are 8728 for the HTTP API, and 8729 for the HTTPS API.
Set to true to validate hostnames in certificates.
See also validate_certs. Only used when tls=true and validate_certs=true.
+Set to true to validate hostnames in certificates.
See also validate_certs. Only used when tls=true and validate_certs=true.
Choices:
Set to false to skip validation of TLS certificates.
See also validate_cert_hostname. Only used when tls=true.
-Note: instead of simply deactivating certificate validations to “make things work”, please consider creating your own CA certificate and using it to sign certificates used for your router. You can tell the module about your CA certificate with the ca_path option.
+Set to false to skip validation of TLS certificates.
See also validate_cert_hostname. Only used when tls=true.
Note: instead of simply deactivating certificate validations to “make things work”, please consider creating your own CA certificate and using it to sign certificates used for your router. You can tell the module about your CA certificate with the ca_path option.
Choices:
Will add selected arguments in selected path to RouterOS config.
-Example address=1.1.1.1/32 interface=ether1.
Example address=1.1.1.1/32 interface=ether1.
Equivalent in RouterOS CLI /ip address add address=1.1.1.1/32 interface=ether1.
PEM formatted file that contains a CA certificate to be used for certificate validation.
-See also validate_cert_hostname. Only used when tls=true and validate_certs=true.
+See also validate_cert_hostname. Only used when tls=true and validate_certs=true.
Execute any/arbitrary command in selected path, after the command we can add .id.
Example path system script and cmd run .id=*03 is equivalent in RouterOS CLI /system script run number=0.
Example path ip address and cmd print is equivalent in RouterOS CLI /ip address print.
Example path system script and cmd run .id=*03 is equivalent in RouterOS CLI /system script run number=0.
Example path ip address and cmd print is equivalent in RouterOS CLI /ip address print.
Use the specified encoding when communicating with the RouterOS device.
-Default is ASCII. Note that UTF-8 requires librouteros 3.2.1 or newer.
Default is ASCII. Note that UTF-8 requires librouteros 3.2.1 or newer.
Default: "ASCII"
list / elements=string / required
The list of attributes to return.
-Every attribute used in a where clause need to be listed here.
+Every attribute used in a extended_query.where[] clause need to be listed here.
Allows to restrict the objects returned.
-The conditions here must all match. An or condition needs at least one of its conditions to match.
+The conditions here must all match. An extended_query.where[].or condition needs at least one of its conditions to match.
The attribute to match. Must be part of attributes.
-Either or or all of attribute, is, and value have to be specified.
+The attribute to match. Must be part of extended_query.attributes.
Either extended_query.where[].or or all of extended_query.where[].attribute, extended_query.where[].is, and extended_query.where[].value have to be specified.
The operator to use for matching.
-For equality use == or eq. For less use < or less. For more use > or more.
Use in to check whether the value is part of a list. In that case, value must be a list.
Either or or all of attribute, is, and value have to be specified.
+For equality use == or eq. For less use < or less. For more use > or more.
Use in to check whether the value is part of a list. In that case, extended_query.where[].value must be a list.
Either extended_query.where[].or or all of extended_query.where[].attribute, extended_query.where[].is, and extended_query.where[].value have to be specified.
Choices:
A list of conditions so that at least one of them has to match.
-Either or or all of attribute, is, and value have to be specified.
+Either extended_query.where[].or or all of extended_query.where[].attribute, extended_query.where[].is, and extended_query.where[].value have to be specified.
The attribute to match. Must be part of attributes.
+The attribute to match. Must be part of extended_query.attributes.
The operator to use for matching.
-For equality use == or eq. For less use < or less. For more use > or more.
Use in to check whether the value is part of a list. In that case, value must be a list.
For equality use == or eq. For less use < or less. For more use > or more.
Use in to check whether the value is part of a list. In that case, extended_query.where[].or[].value must be a list.
Choices:
value
any / required
The value to compare to. Must be a list for is=in.
+The value to compare to. Must be a list for extended_query.where[].or[].is=in.
The value to compare to. Must be a list for is=in.
-Either or or all of attribute, is, and value have to be specified.
+The value to compare to. Must be a list for extended_query.where[].is=in.
Either extended_query.where[].or or all of extended_query.where[].attribute, extended_query.where[].is, and extended_query.where[].value have to be specified.
Set to true to connect without a certificate when tls=true.
See also validate_certs.
-Note: this forces the use of anonymous Diffie-Hellman (ADH) ciphers. The protocol is susceptible to Man-in-the-Middle attacks, because the keys used in the exchange are not authenticated. Instead of simply connecting without a certificate to “make things work” have a look at validate_certs and ca_path.
+Set to true to connect without a certificate when tls=true.
See also validate_certs.
Note: this forces the use of anonymous Diffie-Hellman (ADH) ciphers. The protocol is susceptible to Man-in-the-Middle attacks, because the keys used in the exchange are not authenticated. Instead of simply connecting without a certificate to “make things work” have a look at validate_certs and ca_path.
Choices:
RouterOS api port. If tls is set, port will apply to TLS/SSL connection.
-Defaults are 8728 for the HTTP API, and 8729 for the HTTPS API.
RouterOS api port. If tls is set, port will apply to TLS/SSL connection.
Defaults are 8728 for the HTTP API, and 8729 for the HTTPS API.
string
Remove config/value from RouterOS by ‘.id’.
-Example *03 will remove config/value with id=*03 in selected path.
Example *03 will remove config/value with id=*03 in selected path.
Equivalent in RouterOS CLI /ip address remove numbers=1.
Note number in RouterOS CLI is different from .id.
string
Update config/value in RouterOS by ‘.id’ in selected path.
-Example .id=*03 address=1.1.1.3/32 and path ip address will replace existing ip address with .id=*03.
Example .id=*03 address=1.1.1.3/32 and path ip address will replace existing ip address with .id=*03.
Equivalent in RouterOS CLI /ip address set address=1.1.1.3/32 numbers=1.
Note number in RouterOS CLI is different from .id.
boolean
added in community.routeros 1.2.0
Set to true to validate hostnames in certificates.
See also validate_certs. Only used when tls=true and validate_certs=true.
+Set to true to validate hostnames in certificates.
See also validate_certs. Only used when tls=true and validate_certs=true.
Choices:
Set to false to skip validation of TLS certificates.
See also validate_cert_hostname. Only used when tls=true.
-Note: instead of simply deactivating certificate validations to “make things work”, please consider creating your own CA certificate and using it to sign certificates used for your router. You can tell the module about your CA certificate with the ca_path option.
+Set to false to skip validation of TLS certificates.
See also validate_cert_hostname. Only used when tls=true.
Note: instead of simply deactivating certificate validations to “make things work”, please consider creating your own CA certificate and using it to sign certificates used for your router. You can tell the module about your CA certificate with the ca_path option.
Choices:
false
Note
add, remove, update, cmd and query are mutually exclusive.
Use the community.routeros.api_modify and community.routeros.api_find_and_modify modules for more specific modifications, and the community.routeros.api_info module for a more controlled way of returning all entries for a path.
commands
list / elements=string / required
List of commands to send to the remote RouterOS device over the configured provider. The resulting output from the command is returned. If the wait_for argument is provided, the module is not returned until the condition is satisfied or the number of retries has expired.
+List of commands to send to the remote RouterOS device over the configured provider. The resulting output from the command is returned. If the wait_for argument is provided, the module is not returned until the condition is satisfied or the number of retries has expired.
The match argument is used in conjunction with the wait_for argument to specify the match policy. Valid values are all or any. If the value is set to all then all conditionals in the wait_for must be satisfied. If the value is set to any then only one of the values must be satisfied.
Specifies the number of retries a command should by tried before it is considered failed. The command is run on the target device every retry and evaluated against the wait_for conditions.
+Specifies the number of retries a command should by tried before it is considered failed. The command is run on the target device every retry and evaluated against the wait_for conditions.
Default: 10
It is recommended to always use tls: true when connecting with the API, even if you are only connecting to the device through a trusted network. The following options control how TLS/SSL is used:
It is recommended to always use tls=true when connecting with the API, even if you are only connecting to the device through a trusted network. The following options control how TLS/SSL is used:
Setting to true connects to the device without a certificate. This is discouraged to use in production and is susceptible to Man-in-the-Middle attacks, but might be useful when setting the device up. The default value is false.
Setting to true connects to the device without a certificate. This is discouraged to use in production and is susceptible to Man-in-the-Middle attacks, but might be useful when setting the device up. The default value is false.
Setting to false disables any certificate validation. This is discouraged to use in production, but is needed when setting the device up. The default value is true.
Setting to false disables any certificate validation. This is discouraged to use in production, but is needed when setting the device up. The default value is true.
Setting to false (default) disables hostname verification during certificate validation. This is needed if the hostnames specified in the certificate do not match the hostname used for connecting (usually the device’s IP). It is recommended to set up the certificate correctly and set this to true; the default false is chosen for backwards compatibility to an older version of the module.
Setting to false (default) disables hostname verification during certificate validation. This is needed if the hostnames specified in the certificate do not match the hostname used for connecting (usually the device’s IP). It is recommended to set up the certificate correctly and set this to true; the default false is chosen for backwards compatibility to an older version of the module.
If you are not using a commerically trusted CA certificate to sign your device’s certificate, or have not included your CA certificate in Python’s truststore, you need to point this option to the CA certificate.
diff --git a/branch/main/docsite/quoting.html b/branch/main/docsite/quoting.html index ae5d4e1..d62b2ba 100644 --- a/branch/main/docsite/quoting.html +++ b/branch/main/docsite/quoting.html @@ -134,7 +134,7 @@The community.routeros.quote_argument filter quotes an argument with or without a value: 'comment=this is a "comment"' | community.routeros.quote_argument == 'comment="this is a \\"comment\\""'.
The community.routeros.join filter quotes a list of arguments and joins them to one string: ['foo=bar', 'comment=foo is bar'] | community.routeros.join == 'foo=bar comment="foo is bar"'.
The community.routeros.split filter splits a command into a list of arguments (with or without values): 'foo=bar comment="foo is bar"' | community.routeros.split == ['foo=bar', 'comment=foo is bar']
The community.routeros.list_to_dict filter splits a list of arguments with values into a dictionary: ['foo=bar', 'comment=foo is bar'] | community.routeros.list_to_dict == {'foo': 'bar', 'comment': 'foo is bar'}. It has two optional arguments: require_assignment (default value true) allows to accept arguments without values when set to false; and skip_empty_values (default value false) allows to skip arguments whose value is empty.
The community.routeros.list_to_dict filter splits a list of arguments with values into a dictionary: ['foo=bar', 'comment=foo is bar'] | community.routeros.list_to_dict == {'foo': 'bar', 'comment': 'foo is bar'}. It has two optional arguments: require_assignment (default value true) allows to accept arguments without values when set to false; and skip_empty_values (default value false) allows to skip arguments whose value is empty.
When using the community.routeros.command module module, make sure to not specify too long commands. Alternatively, add something like +cet512w to the username (replace admin with admin+cet512w) to tell RouterOS to not wrap before 512 characters in a line (see issue for details).
Finally, the ansible.netcommon.network_cli connection plugin uses paramiko by default to connect to devices with SSH. You can set its ssh_type option to libssh to use ansible-pylibssh instead, which offers Python bindings to libssh. See its documentation for details.
Finally, the ansible.netcommon.network_cli connection plugin uses paramiko by default to connect to devices with SSH. You can set its ssh_type`libssh to use ansible-pylibssh instead, which offers Python bindings to libssh. See its documentation for details.
gather_subset
list / elements=string
When supplied, this argument will restrict the facts collected to a given subset. Possible values for this argument include all, hardware, config, interfaces, and routing.
Can specify a list of values to include a larger subset. Values can also be used with an initial ! to specify that a specific subset should not be collected.
When supplied, this argument will restrict the facts collected to a given subset. Possible values for this argument include all, hardware, config, interfaces, and routing.
Can specify a list of values to include a larger subset. Values can also be used with an initial ! to specify that a specific subset should not be collected.
Default: ["!config"]
list / elements=string
All IPv4 addresses configured on the device.
-Returned: gather_subset contains interfaces
Returned: gather_subset contains interfaces
All IPv6 addresses configured on the device.
-Returned: gather_subset contains interfaces
Returned: gather_subset contains interfaces
The CPU architecture of the device.
-Returned: gather_subset contains default
Returned: gather_subset contains default
A dictionary with BGP instance information.
-Returned: gather_subset contains routing
Returned: gather_subset contains routing
A dictionary with BGP peer information.
-Returned: gather_subset contains routing
Returned: gather_subset contains routing
A dictionary with BGP vpnv4 route information.
-Returned: gather_subset contains routing
Returned: gather_subset contains routing
The current active config from the device.
-Returned: gather_subset contains config
Returned: gather_subset contains config
The current active config from the device in minimal form.
This value is idempotent in the sense that if the facts module is run twice and the device’s config was not changed between the runs, the value is identical. This is achieved by running /export and stripping the timestamp from the comment in the first line.
Returned: gather_subset contains config
Returned: gather_subset contains config
Current CPU load.
-Returned: gather_subset contains default
Returned: gather_subset contains default
The configured hostname of the device.
-Returned: gather_subset contains default
Returned: gather_subset contains default
A hash of all interfaces running on the system.
-Returned: gather_subset contains interfaces
Returned: gather_subset contains interfaces
The available free memory on the remote device in MiB.
-Returned: gather_subset contains hardware
Returned: gather_subset contains hardware
The total memory on the remote device in MiB.
-Returned: gather_subset contains hardware
Returned: gather_subset contains hardware
The model name returned from the device.
-Returned: gather_subset contains default
Returned: gather_subset contains default
The list of neighbors from the remote device.
-Returned: gather_subset contains interfaces
Returned: gather_subset contains interfaces
A dictionary with OSPF instances.
-Returned: gather_subset contains routing
Returned: gather_subset contains routing
A dictionary with OSPF neighbors.
-Returned: gather_subset contains routing
Returned: gather_subset contains routing
A dictionary for routes in all routing tables.
-Returned: gather_subset contains routing
Returned: gather_subset contains routing
The serial number of the remote device.
-Returned: gather_subset contains default
Returned: gather_subset contains default
The available disk space on the remote device in MiB.
-Returned: gather_subset contains hardware
Returned: gather_subset contains hardware
The total disk space on the remote device in MiB.
-Returned: gather_subset contains hardware
Returned: gather_subset contains hardware
The uptime of the device.
-Returned: gather_subset contains default
Returned: gather_subset contains default
The operating system version running on the remote device.
-Returned: gather_subset contains default
Returned: gather_subset contains default
Input
list / elements=string / required
A list of assignments. Can be the result of the community.routeros.split filter.
A list of assignments. Can be the result of the community.routeros.split filter.
inputrequire_assignment
boolean
Allows to accept arguments without values when set to false.
Allows to accept arguments without values when set to false.
Choices:
false
inputskip_empty_values
boolean
Allows to skip arguments whose value is empty when set to true.
Allows to skip arguments whose value is empty when set to true.
Choices:
false ← (default)