alliedtelesis.awplus.awplus_vrf (1.2.2) — module

Install collection

Install with ansible-galaxy collection install alliedtelesis.awplus:==1.2.2

Add to requirements.yml

  collections:
    - name: alliedtelesis.awplus
      version: 1.2.2

Description

This module provides declarative management of VRF definitions on Awplus devices. It allows playbooks to manage individual or the entire VRF collection. It also supports purging VRF definitions from the configuration that are not explicitly defined.

Inputs

    
rd:
    description:
    - The router-distinguisher value uniquely identifies the VRF to routing processes
      on the remote Awplus system. The RD value takes the form of C(A:B) where C(A) and
      C(B) are both numeric values.

name:
    description:
    - The name of the VRF definition to be managed on the remote Awplus device. The VRF
      definition name is an ASCII string name used to uniquely identify the VRF. This
      argument is mutually exclusive with the C(vrfs) argument

vrfs:
    description:
    - The set of VRF definition objects to be configured on the remote Awplus device.
      Ths list entries can either be the VRF name or a hash of VRF definitions and attributes.
      This argument is mutually exclusive with the C(name) argument.

delay:
    default: 10
    description:
    - Time in seconds to wait before checking for the operational state on remote device.

purge:
    default: false
    description:
    - Instructs the module to consider the VRF definition absolute. It will remove any
      previously configured VRFs on the device.
    type: bool

state:
    choices:
    - present
    - absent
    default: present
    description:
    - Configures the state of the VRF definition as it relates to the device operational
      configuration. When set to I(present), the VRF should be configured in the device
      active configuration and when set to I(absent) the VRF should not be in the device
      active configuration

interfaces:
    description:
    - Identifies the set of interfaces that should be configured in the VRF. Interfaces
      must be routed interfaces in order to be placed into a VRF.

route_both:
    description:
    - Adds an export and import list of extended route target communities to the VRF.

description:
    description:
    - Provides a short description of the VRF definition in the current active configuration.
      The VRF definition value accepts alphanumeric characters used to provide additional
      information about the VRF.

route_export:
    description:
    - Adds an export list of extended route target communities to the VRF.

route_import:
    description:
    - Adds an import list of extended route target communities to the VRF.

route_both_ipv4:
    description:
    - Adds an export and import list of extended route target communities in address-family
      configuration submode to the VRF.

route_both_ipv6:
    description:
    - Adds an export and import list of extended route target communities in address-family
      configuration submode to the VRF.

route_export_ipv4:
    description:
    - Adds an export list of extended route target communities in address-family configuration
      submode to the VRF.

route_export_ipv6:
    description:
    - Adds an export list of extended route target communities in address-family configuration
      submode to the VRF.

route_import_ipv4:
    description:
    - Adds an import list of extended route target communities in address-family configuration
      submode to the VRF.

route_import_ipv6:
    description:
    - Adds an import list of extended route target communities in address-family configuration
      submode to the VRF.

associated_interfaces:
    description:
    - This is a intent option and checks the operational state of the for given vrf C(name)
      for associated interfaces. If the value in the C(associated_interfaces) does not
      match with the operational state of vrf interfaces on device it will result in failure.

Outputs

commands:
  description: The list of configuration mode commands to send to the device
  returned: always
  sample:
  - vrf definition ansible
  - description management vrf
  - rd: 1:100
  type: list
delta:
  description: The time elapsed to perform all operations
  returned: always
  sample: '0:00:10.469466'
  type: str
end:
  description: The time the job ended
  returned: always
  sample: '2016-11-16 10:38:25.595612'
  type: str
start:
  description: The time the job started
  returned: always
  sample: '2016-11-16 10:38:15.126146'
  type: str