cisco.nxos.nxos_gir_profile_management (7.0.0) — module

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

| "added in version" 1.0.0 of cisco.nxos"

Authors: Gabriele Gerbino (@GGabriele)

Install collection

Install with ansible-galaxy collection install cisco.nxos:==7.0.0


Add to requirements.yml

  collections:
    - name: cisco.nxos
      version: 7.0.0

Description

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

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
# Create a maintenance-mode profile
- cisco.nxos.nxos_gir_profile_management:
    mode: maintenance
    commands:
      - router eigrp 11
      - isolate
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
# Remove the maintenance-mode profile
- cisco.nxos.nxos_gir_profile_management:
    mode: maintenance
    state: absent

Inputs

    
mode:
    choices:
    - maintenance
    - normal
    description:
    - Configure the profile as Maintenance or Normal mode.
    required: true
    type: str

state:
    choices:
    - present
    - absent
    default: present
    description:
    - Specify desired state of the resource.
    type: str

commands:
    description:
    - List of commands to be included into the profile.
    elements: str
    type: list

Outputs

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