Class: Ansible::Ruby::Modules::Ios_vrf
- Inherits:
-
Base
- Object
- Ansible::Ruby::Models::Base
- Base
- Ansible::Ruby::Modules::Ios_vrf
- Defined in:
- lib/ansible/ruby/modules/generated/network/ios/ios_vrf.rb
Overview
This module provides declarative management of VRF definitions on Cisco IOS 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.
Instance Method Summary collapse
-
#associated_interfaces ⇒ Object?
This is a intent option and checks the operational state of the for given vrf C(name) for associated interfaces.
-
#delay ⇒ Integer?
Time in seconds to wait before checking for the operational state on remote device.
-
#description ⇒ String?
Provides a short description of the VRF definition in the current active configuration.
-
#interfaces ⇒ Array<String>, ...
Identifies the set of interfaces that should be configured in the VRF.
-
#name ⇒ String?
The name of the VRF definition to be managed on the remote IOS device.
-
#purge ⇒ Boolean?
Instructs the module to consider the VRF definition absolute.
-
#rd ⇒ String?
The router-distinguisher value uniquely identifies the VRF to routing processes on the remote IOS system.
-
#route_both ⇒ Array<String>, ...
Adds an export and import list of extended route target communities to the VRF.
-
#route_both_ipv4 ⇒ Array<String>, ...
Adds an export and import list of extended route target communities in address-family configuration submode to the VRF.
-
#route_both_ipv6 ⇒ Array<String>, ...
Adds an export and import list of extended route target communities in address-family configuration submode to the VRF.
-
#route_export ⇒ Array<String>, ...
Adds an export list of extended route target communities to the VRF.
-
#route_export_ipv4 ⇒ Array<String>, ...
Adds an export list of extended route target communities in address-family configuration submode to the VRF.
-
#route_export_ipv6 ⇒ Array<String>, ...
Adds an export list of extended route target communities in address-family configuration submode to the VRF.
-
#route_import ⇒ Array<String>, ...
Adds an import list of extended route target communities to the VRF.
-
#route_import_ipv4 ⇒ Array<String>, ...
Adds an import list of extended route target communities in address-family configuration submode to the VRF.
-
#route_import_ipv6 ⇒ Array<String>, ...
Adds an import list of extended route target communities in address-family configuration submode to the VRF.
-
#state ⇒ :present, ...
Configures the state of the VRF definition as it relates to the device operational configuration.
-
#vrfs ⇒ Array<String>, ...
The set of VRF definition objects to be configured on the remote IOS device.
Methods inherited from Base
Methods inherited from Ansible::Ruby::Models::Base
attr_option, attr_options, attribute, #initialize, remove_existing_validations, #to_h, validates
Constructor Details
This class inherits a constructor from Ansible::Ruby::Models::Base
Instance Method Details
#associated_interfaces ⇒ Object?
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.
32 |
# File 'lib/ansible/ruby/modules/generated/network/ios/ios_vrf.rb', line 32 attribute :associated_interfaces |
#delay ⇒ Integer?
Returns Time in seconds to wait before checking for the operational state on remote device.
35 |
# File 'lib/ansible/ruby/modules/generated/network/ios/ios_vrf.rb', line 35 attribute :delay |
#description ⇒ String?
Returns 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.
20 |
# File 'lib/ansible/ruby/modules/generated/network/ios/ios_vrf.rb', line 20 attribute :description |
#interfaces ⇒ Array<String>, ...
Returns 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.
28 |
# File 'lib/ansible/ruby/modules/generated/network/ios/ios_vrf.rb', line 28 attribute :interfaces |
#name ⇒ String?
Returns The name of the VRF definition to be managed on the remote IOS 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.
16 |
# File 'lib/ansible/ruby/modules/generated/network/ios/ios_vrf.rb', line 16 attribute :name |
#purge ⇒ Boolean?
Returns Instructs the module to consider the VRF definition absolute. It will remove any previously configured VRFs on the device.
39 |
# File 'lib/ansible/ruby/modules/generated/network/ios/ios_vrf.rb', line 39 attribute :purge |
#rd ⇒ String?
Returns The router-distinguisher value uniquely identifies the VRF to routing processes on the remote IOS system. The RD value takes the form of C(A:B) where C(A) and C(B) are both numeric values.
24 |
# File 'lib/ansible/ruby/modules/generated/network/ios/ios_vrf.rb', line 24 attribute :rd |
#route_both ⇒ Array<String>, ...
Returns Adds an export and import list of extended route target communities to the VRF.
47 |
# File 'lib/ansible/ruby/modules/generated/network/ios/ios_vrf.rb', line 47 attribute :route_both |
#route_both_ipv4 ⇒ Array<String>, ...
Returns Adds an export and import list of extended route target communities in address-family configuration submode to the VRF.
59 |
# File 'lib/ansible/ruby/modules/generated/network/ios/ios_vrf.rb', line 59 attribute :route_both_ipv4 |
#route_both_ipv6 ⇒ Array<String>, ...
Returns Adds an export and import list of extended route target communities in address-family configuration submode to the VRF.
71 |
# File 'lib/ansible/ruby/modules/generated/network/ios/ios_vrf.rb', line 71 attribute :route_both_ipv6 |
#route_export ⇒ Array<String>, ...
Returns Adds an export list of extended route target communities to the VRF.
51 |
# File 'lib/ansible/ruby/modules/generated/network/ios/ios_vrf.rb', line 51 attribute :route_export |
#route_export_ipv4 ⇒ Array<String>, ...
Returns Adds an export list of extended route target communities in address-family configuration submode to the VRF.
63 |
# File 'lib/ansible/ruby/modules/generated/network/ios/ios_vrf.rb', line 63 attribute :route_export_ipv4 |
#route_export_ipv6 ⇒ Array<String>, ...
Returns Adds an export list of extended route target communities in address-family configuration submode to the VRF.
75 |
# File 'lib/ansible/ruby/modules/generated/network/ios/ios_vrf.rb', line 75 attribute :route_export_ipv6 |
#route_import ⇒ Array<String>, ...
Returns Adds an import list of extended route target communities to the VRF.
55 |
# File 'lib/ansible/ruby/modules/generated/network/ios/ios_vrf.rb', line 55 attribute :route_import |
#route_import_ipv4 ⇒ Array<String>, ...
Returns Adds an import list of extended route target communities in address-family configuration submode to the VRF.
67 |
# File 'lib/ansible/ruby/modules/generated/network/ios/ios_vrf.rb', line 67 attribute :route_import_ipv4 |
#route_import_ipv6 ⇒ Array<String>, ...
Returns Adds an import list of extended route target communities in address-family configuration submode to the VRF.
79 |
# File 'lib/ansible/ruby/modules/generated/network/ios/ios_vrf.rb', line 79 attribute :route_import_ipv6 |
#state ⇒ :present, ...
Returns 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.
43 |
# File 'lib/ansible/ruby/modules/generated/network/ios/ios_vrf.rb', line 43 attribute :state |
#vrfs ⇒ Array<String>, ...
Returns The set of VRF definition objects to be configured on the remote IOS 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.
12 |
# File 'lib/ansible/ruby/modules/generated/network/ios/ios_vrf.rb', line 12 attribute :vrfs |