cisco.nxos.nxos_gir_profile_management_module.rst

cisco.nxos.nxos_gir_profile_management

Create a maintenance-mode or normal-mode profile for GIR.

Version added: 1.0.0

• Synopsis
• Parameters
• Notes
• Examples
• Return Values
• Status

Synopsis

• Manage a maintenance-mode or normal-mode profile with configuration commands that can be applied during graceful removal or graceful insertion.

Parameters

Parameter	Choices/Defaults	Comments
commands list / elements=string		List of commands to be included into the profile.
mode string / required	Choices: maintenance normal	Configure the profile as Maintenance or Normal mode.
state string	Choices: present ← absent	Specify desired state of the resource.

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.

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	Returned	Description
changed boolean	always	check to see if a change was made on the device Sample: True
end_state list	verbose mode	list of profile entries after module execution. Sample: ['router bgp 65535', 'isolate', 'router eigrp 10', 'isolate', 'diagnostic bootup level complete', 'router eigrp 11', 'isolate']
existing list	verbose mode	list of existing profile commands. Sample: ['router bgp 65535', 'isolate', 'router eigrp 10', 'isolate', 'diagnostic bootup level complete']
proposed list	verbose mode	list of commands passed into module. Sample: ['router eigrp 11', 'isolate']
updates list	always	commands sent to the device Sample: ['configure maintenance profile maintenance-mode', 'router eigrp 11', 'isolate']

Status

Authors

• Gabriele Gerbino (@GGabriele)