nxos_gir_profile_management - Create a maintenance-mode or normal-mode profile for GIR.
New in version 2.2.
Synopsis
- Manage a maintenance-mode or normal-mode profile with configuration commands that can be applied during graceful removal or graceful insertion.
Options
parameter | required | default | choices | comments |
---|---|---|---|---|
auth_pass (added in 2.4.4)
| no | none | Specifies the password to use if required to enter privileged mode on the remote device. If authorize is false, then this argument does nothing. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_AUTH_PASS will be used instead. | |
authorize (added in 2.4.4)
| no |
| Instructs the module to enter privileged mode on the remote device before sending any commands. If not specified, the device will attempt to execute all commands in non-privileged mode. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_AUTHORIZE will be used instead. | |
commands | no | List of commands to be included into the profile. | ||
config | no | Specify the configuration string to be used for module operations. | ||
host | yes | Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. | ||
include_defaults | no |
| Specify to retrieve or not the complete running configuration for module operations. | |
mode | yes |
| Configure the profile as Maintenance or Normal mode. | |
password | no | Specifies the password to use to authenticate the connection to the remote device. This is a common argument used for either cli or nxapi transports. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead. | ||
port | no | 0 (use common port) | Specifies the port to use when building the connection to the remote device. This value applies to either cli or nxapi. The port value will default to the appropriate transport common port if none is provided in the task. (cli=22, http=80, https=443). | |
provider | no | Convenience method that allows all nxos arguments to be passed as a dict object. All constraints (required, choices, etc) must be met either by individual arguments or values in this dict. | ||
ssh_keyfile | no | Specifies the SSH key to use to authenticate the connection to the remote device. This argument is only used for the cli transport. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_SSH_KEYFILE will be used instead. | ||
state | no | present |
| Specify desired state of the resource. |
timeout (added in 2.3)
| no | 10 | Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. NX-API can be slow to return on long-running commands (sh mac, sh bgp, etc). | |
transport | yes | cli | Configures the transport connection to use when connecting to the remote device. The transport argument supports connectivity to the device over cli (ssh) or nxapi. | |
use_ssl | no |
| Configures the transport to use SSL if set to true only when the transport=nxapi , otherwise this value is ignored. | |
username | no | Configures the username to use to authenticate the connection to the remote device. This value is used to authenticate either the CLI login or the nxapi authentication depending on which transport is used. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead. | ||
validate_certs | no |
| If no , SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. If the transport argument is not nxapi, this value is ignored. |
Examples
# Create a maintenance-mode profile - nxos_gir_profile_management: mode: maintenance commands: - router eigrp 11 - isolate host: "{{ inventory_hostname }}" username: "{{ un }}" password: "{{ pwd }}" # Remove the maintenance-mode profile - nxos_gir_profile_management: mode: maintenance state: absent host: "{{ inventory_hostname }}" username: "{{ un }}" password: "{{ pwd }}"
Return Values
Common return values are documented here Return Values, the following are the fields unique to this module:
name | description | returned | type | sample |
---|---|---|---|---|
changed | check to see if a change was made on the device | always | boolean | True |
end_state | list of profile entries after module execution. | verbose mode | list | ['router bgp 65535', 'isolate', 'router eigrp 10', 'isolate', 'diagnostic bootup level complete', 'router eigrp 11', 'isolate'] |
existing | list of existing profile commands. | verbose mode | list | ['router bgp 65535', 'isolate', 'router eigrp 10', 'isolate', 'diagnostic bootup level complete'] |
proposed | list of commands passed into module. | verbose mode | list | ['router eigrp 11', 'isolate'] |
updates | commands sent to the device | always | list | ['configure maintenance profile maintenance-mode', 'router eigrp 11', 'isolate'] |
Notes
Note
- Tested against NXOSv 7.3.(0)D1(1) on VIRL
-
state=absent
removes the whole profile.
Status
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
Maintenance Info
For more information about Red Hat’s this support of this module, please refer to this knowledge base article<https://access.redhat.com/articles/rhel-top-support-policies>
For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/nxos_gir_profile_management_module.html