Class: Ansible::Ruby::Modules::Nxos_vrf

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/network/nxos/nxos_vrf.rb

Overview

This module provides declarative management of VRFs on CISCO NXOS network devices.

Instance Method Summary collapse

Methods inherited from Base

#ansible_name, #to_h

Methods inherited from Ansible::Ruby::Models::Base

attr_option, attr_options, attribute, fix_inclusion, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

This class inherits a constructor from Ansible::Ruby::Models::Base

Instance Method Details

#admin_state ⇒ :up, ...

Returns Administrative state of the VRF.

Returns:

  • (:up, :down, nil) —

    Administrative state of the VRF.



16
 
# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_vrf.rb', line 16

attribute :admin_state

#aggregate ⇒ Array<Hash>, ...

Returns List of VRFs definitions.

Returns:

  • (Array<Hash>, Hash, nil) —

    List of VRFs definitions.



34
 
# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_vrf.rb', line 34

attribute :aggregate

#associated_interfaces ⇒ Array<String>, ...

Returns 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.

Returns:

  • (Array<String>, String, nil) —

    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.



30
 
# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_vrf.rb', line 30

attribute :associated_interfaces

#delay ⇒ Integer?

Returns Time in seconds to wait before checking for the operational state on remote device. This wait is applicable for operational state arguments.

Returns:

  • (Integer, nil) —

    Time in seconds to wait before checking for the operational state on remote device. This wait is applicable for operational state arguments.



50
 
# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_vrf.rb', line 50

attribute :delay

#description ⇒ String?

Returns Description of the VRF or keyword ‘default’.

Returns:

  • (String, nil) —

    Description of the VRF or keyword ‘default’.



46
 
# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_vrf.rb', line 46

attribute :description

#interfaces ⇒ Array<String>, ...

Returns List of interfaces to check the VRF has been configured correctly or keyword ‘default’.

Returns:

  • (Array<String>, String, nil) —

    List of interfaces to check the VRF has been configured correctly or keyword ‘default’.



26
 
# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_vrf.rb', line 26

attribute :interfaces

#name ⇒ String

Returns Name of VRF to be managed.

Returns:

  • (String) —

    Name of VRF to be managed.



12
 
# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_vrf.rb', line 12

attribute :name

#purge ⇒ :yes, ...

Returns Purge VRFs not defined in the I(aggregate) parameter.

Returns:

  • (:yes, :no, nil) —

    Purge VRFs not defined in the I(aggregate) parameter.



38
 
# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_vrf.rb', line 38

attribute :purge

#rd ⇒ Object?

Returns 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’.

Returns:

  • (Object, nil) —

    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’.



23
 
# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_vrf.rb', line 23

attribute :rd

#state ⇒ :present, ...

Returns Manages desired state of the resource.

Returns:

  • (:present, :absent, nil) —

    Manages desired state of the resource.



42
 
# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_vrf.rb', line 42

attribute :state

#vni ⇒ Object?

Returns Specify virtual network identifier. Valid values are Integer or keyword ‘default’.

Returns:

  • (Object, nil) —

    Specify virtual network identifier. Valid values are Integer or keyword ‘default’.



20
 
# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_vrf.rb', line 20

attribute :vni