ansible.builtin.nxos_vrf (v2.3.3.0-1) — module

Install Ansible via pip

Install with pip install ansible==2.3.3.0.post1

Description

Manages global VRF configuration.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Ensure ntc VRF exists on switch
  nxos_vrf:
    vrf: ntc
    username: "{{ un }}"
    password: "{{ pwd }}"
    host: "{{ inventory_hostname }}"

Inputs

    
vni:
    default: null
    description:
    - Specify virtual network identifier. Valid values are Integer or keyword 'default'.
    required: false
    version_added: '2.2'
    version_added_collection: ansible.builtin

vrf:
    description:
    - Name of VRF to be managed.
    required: true

state:
    choices:
    - present
    - absent
    default: present
    description:
    - Manages desired state of the resource.
    required: false

admin_state:
    choices:
    - up
    - down
    default: up
    description:
    - Administrative state of the VRF.
    required: false

description:
    default: null
    description:
    - Description of the VRF.
    required: false

route_distinguisher:
    default: null
    description:
    - VPN Route Distinguisher (RD). Valid values are a string in one of the route-distinguisher
      formats (ASN2:NN, ASN4:NN, or IPV4:NN); the keyword 'auto', or the keyword 'default'.
    required: false
    version_added: '2.2'
    version_added_collection: ansible.builtin

Outputs

changed:
  description: check to see if a change was made on the device
  returned: always
  sample: true
  type: boolean
end_state:
  description: k/v pairs of vrf info after module execution
  returned: always
  sample:
    admin_state: Up
    description: Test test
    vrf: ntc
  type: dict
existing:
  description: k/v pairs of existing vrf
  returned: always
  sample:
    admin_state: Up
    description: Old test
    vrf: old_ntc
  type: dict
proposed:
  description: k/v pairs of parameters passed into module
  returned: always
  sample:
    admin_state: Up
    description: Test test
    vrf: ntc
  type: dict
updates:
  description: commands sent to the device
  returned: always
  sample:
  - vrf context ntc
  - shutdown
  type: list