cisco.nxos.nxos_gir_profile_management module – Create a maintenance-mode or normal-mode profile for GIR.
Note
This module is part of the cisco.nxos collection (version 8.1.0).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install cisco.nxos
.
To use it in a playbook, specify: cisco.nxos.nxos_gir_profile_management
.
New in cisco.nxos 1.0.0
Synopsis
Manage a maintenance-mode or normal-mode profile with configuration commands that can be applied during graceful removal or graceful insertion.
Aliases: gir_profile_management
Parameters
Parameter |
Comments |
---|---|
List of commands to be included into the profile. |
|
Configure the profile as Maintenance or Normal mode. Choices:
|
|
Specify desired state of the resource. Choices:
|
Notes
Note
Tested against NXOSv 7.3.(0)D1(1) on VIRL
Unsupported for Cisco MDS
state=absent
removes the whole profile.For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide <nxos_platform_options>`
For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide <network_guide>`
For more information on using Ansible to manage Cisco devices see the `Cisco integration page <https://www.ansible.com/integrations/networks/cisco>`_.
Examples
# Create a maintenance-mode profile
- cisco.nxos.nxos_gir_profile_management:
mode: maintenance
commands:
- router eigrp 11
- isolate
# Remove the maintenance-mode profile
- cisco.nxos.nxos_gir_profile_management:
mode: maintenance
state: absent
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
check to see if a change was made on the device Returned: always Sample: |
|
list of profile entries after module execution. Returned: verbose mode Sample: |
|
list of existing profile commands. Returned: verbose mode Sample: |
|
list of commands passed into module. Returned: verbose mode Sample: |
|
commands sent to the device Returned: always Sample: |