ansible / ansible.builtin / v2.9.3 / module / nxos_gir_profile_management Create a maintenance-mode or normal-mode profile for GIR. | "added in version" 2.2 of ansible.builtin" Authors: Gabriele Gerbino (@GGabriele) preview | supported by networkansible.builtin.nxos_gir_profile_management (v2.9.3) — module
pip
Install with pip install ansible==2.9.3
Manage a maintenance-mode or normal-mode profile with configuration commands that can be applied during graceful removal or graceful insertion.
# Create a maintenance-mode profile - nxos_gir_profile_management: mode: maintenance commands: - router eigrp 11 - isolate
# Remove the maintenance-mode profile - nxos_gir_profile_management: mode: maintenance state: absent
mode: choices: - maintenance - normal description: - Configure the profile as Maintenance or Normal mode. required: true state: choices: - present - absent default: present description: - Specify desired state of the resource. commands: description: - List of commands to be included into the profile. provider: description: - B(Deprecated) - 'Starting with Ansible 2.5 we recommend using C(connection: network_cli).' - This option is only required if you are using NX-API. - For more information please see the L(NXOS Platform Options guide, ../network/user_guide/platform_nxos.html). - HORIZONTALLINE - A dict object containing connection details. suboptions: auth_pass: description: - Specifies the password to use if required to enter privileged mode on the remote device. If I(authorize) is false, then this argument does nothing. If the value is not specified in the task, the value of environment variable C(ANSIBLE_NET_AUTH_PASS) will be used instead. type: str version_added: 2.5.3 version_added_collection: cisco.nxos authorize: default: false description: - 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 C(ANSIBLE_NET_AUTHORIZE) will be used instead. type: bool version_added: 2.5.3 version_added_collection: cisco.nxos host: description: - 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. required: true type: str password: description: - Specifies the password to use to authenticate the connection to the remote device. This is a common argument used for either I(cli) or I(nxapi) transports. If the value is not specified in the task, the value of environment variable C(ANSIBLE_NET_PASSWORD) will be used instead. type: str port: default: 0 (use common port) description: - Specifies the port to use when building the connection to the remote device. This value applies to either I(cli) or I(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). type: int ssh_keyfile: description: - Specifies the SSH key to use to authenticate the connection to the remote device. This argument is only used for the I(cli) transport. If the value is not specified in the task, the value of environment variable C(ANSIBLE_NET_SSH_KEYFILE) will be used instead. type: str timeout: default: 10 description: - 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). type: int version_added: '2.3' version_added_collection: cisco.nxos transport: choices: - cli - nxapi default: cli description: - 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. required: true type: str use_proxy: default: true description: - If C(no), the environment variables C(http_proxy) and C(https_proxy) will be ignored. type: bool version_added: '2.5' version_added_collection: cisco.nxos use_ssl: default: false description: - Configures the I(transport) to use SSL if set to C(yes) only when the C(transport=nxapi), otherwise this value is ignored. type: bool username: description: - 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 C(ANSIBLE_NET_USERNAME) will be used instead. type: str validate_certs: default: true description: - If C(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. type: bool type: dict
changed: description: check to see if a change was made on the device returned: always sample: true type: bool end_state: description: list of profile entries after module execution. returned: verbose mode sample: - router bgp 65535 - isolate - router eigrp 10 - isolate - diagnostic bootup level complete - router eigrp 11 - isolate type: list existing: description: list of existing profile commands. returned: verbose mode sample: - router bgp 65535 - isolate - router eigrp 10 - isolate - diagnostic bootup level complete type: list proposed: description: list of commands passed into module. returned: verbose mode sample: - router eigrp 11 - isolate type: list updates: description: commands sent to the device returned: always sample: - configure maintenance profile maintenance-mode - router eigrp 11 - isolate type: list