Class: Ansible::Ruby::Modules::Aci_bd_subnet

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

Overview

Manage Subnets on Cisco ACI fabrics.

Instance Method Summary collapse

Methods inherited from Base

#ansible_name, #to_h

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

#bd ⇒ String?

Returns The name of the Bridge Domain.

Returns:

  • (String, nil) —

    The name of the Bridge Domain.



12
 
# File 'lib/ansible/ruby/modules/generated/network/aci/aci_bd_subnet.rb', line 12

attribute :bd

#description ⇒ String?

Returns The description for the Subnet.

Returns:

  • (String, nil) —

    The description for the Subnet.



16
 
# File 'lib/ansible/ruby/modules/generated/network/aci/aci_bd_subnet.rb', line 16

attribute :description

#enable_vip ⇒ Object?

Returns Determines if the Subnet should be treated as a VIP; used when the BD is extended to multiple sites.,The APIC defaults to C(no) when unset during creation.

Returns:

  • (Object, nil) —

    Determines if the Subnet should be treated as a VIP; used when the BD is extended to multiple sites.,The APIC defaults to C(no) when unset during creation.



20
 
# File 'lib/ansible/ruby/modules/generated/network/aci/aci_bd_subnet.rb', line 20

attribute :enable_vip

#gateway ⇒ String?

Returns The IPv4 or IPv6 gateway address for the Subnet.

Returns:

  • (String, nil) —

    The IPv4 or IPv6 gateway address for the Subnet.



23
 
# File 'lib/ansible/ruby/modules/generated/network/aci/aci_bd_subnet.rb', line 23

attribute :gateway

#mask ⇒ Integer?

Returns The subnet mask for the Subnet.,This is the number assocated with CIDR notation.,For IPv4 addresses, accepted values range between C(0) and C(32).,For IPv6 addresses, accepted Values range between C(0) and C(128).

Returns:

  • (Integer, nil) —

    The subnet mask for the Subnet.,This is the number assocated with CIDR notation.,For IPv4 addresses, accepted values range between C(0) and C(32).,For IPv6 addresses, accepted Values range between C(0) and C(128).



27
 
# File 'lib/ansible/ruby/modules/generated/network/aci/aci_bd_subnet.rb', line 27

attribute :mask

#nd_prefix_policy ⇒ Object?

Returns The IPv6 Neighbor Discovery Prefix Policy to associate with the Subnet.

Returns:

  • (Object, nil) —

    The IPv6 Neighbor Discovery Prefix Policy to associate with the Subnet.



31
 
# File 'lib/ansible/ruby/modules/generated/network/aci/aci_bd_subnet.rb', line 31

attribute :nd_prefix_policy

#preferred ⇒ Object?

Returns Determines if the Subnet is preferred over all available Subnets. Only one Subnet per Address Family (IPv4/IPv6). can be preferred in the Bridge Domain.,The APIC defaults to C(no) when unset during creation.

Returns:

  • (Object, nil) —

    Determines if the Subnet is preferred over all available Subnets. Only one Subnet per Address Family (IPv4/IPv6). can be preferred in the Bridge Domain.,The APIC defaults to C(no) when unset during creation.



34
 
# File 'lib/ansible/ruby/modules/generated/network/aci/aci_bd_subnet.rb', line 34

attribute :preferred

#route_profile ⇒ String?

Returns The Route Profile to the associate with the Subnet.

Returns:

  • (String, nil) —

    The Route Profile to the associate with the Subnet.



37
 
# File 'lib/ansible/ruby/modules/generated/network/aci/aci_bd_subnet.rb', line 37

attribute :route_profile

#route_profile_l3_out ⇒ String?

Returns The L3 Out that contains the assocated Route Profile.

Returns:

  • (String, nil) —

    The L3 Out that contains the assocated Route Profile.



41
 
# File 'lib/ansible/ruby/modules/generated/network/aci/aci_bd_subnet.rb', line 41

attribute :route_profile_l3_out

#scope ⇒ :private, ...

Returns Determines the scope of the Subnet.,The C(private) option only allows communication with hosts in the same VRF.,The C(public) option allows the Subnet to be advertised outside of the ACI Fabric, and allows communication with hosts in other VRFs.,The shared option limits communication to hosts in either the same VRF or the shared VRF.,The value is a list of options, C(private) and C(public) are mutually exclusive, but both can be used with C(shared).,The APIC defaults to C(private) when unset during creation.

Returns:

  • (:private, :public, :shared, nil) —

    Determines the scope of the Subnet.,The C(private) option only allows communication with hosts in the same VRF.,The C(public) option allows the Subnet to be advertised outside of the ACI Fabric, and allows communication with hosts in other VRFs.,The shared option limits communication to hosts in either the same VRF or the shared VRF.,The value is a list of options, C(private) and C(public) are mutually exclusive, but both can be used with C(shared).,The APIC defaults to C(private) when unset during creation.



45
 
# File 'lib/ansible/ruby/modules/generated/network/aci/aci_bd_subnet.rb', line 45

attribute :scope

#state ⇒ :absent, ...

Returns Use C(present) or C(absent) for adding or removing.,Use C(query) for listing an object or multiple objects.

Returns:

  • (:absent, :present, :query, nil) —

    Use C(present) or C(absent) for adding or removing.,Use C(query) for listing an object or multiple objects.



61
 
# File 'lib/ansible/ruby/modules/generated/network/aci/aci_bd_subnet.rb', line 61

attribute :state

#subnet_control ⇒ :nd_ra, ...

Returns Determines the Subnet’s Control State.,The C(querier_ip) option is used to treat the gateway_ip as an IGMP querier source IP.,The C(nd_ra) option is used to treate the gateway_ip address as a Neighbor Discovery Router Advertisement Prefix.,The C(no_gw) option is used to remove default gateway functionality from the gateway address.,The APIC defaults to C(nd_ra) when unset during creation.

Returns:

  • (:nd_ra, :no_gw, :querier_ip, :unspecified, nil) —

    Determines the Subnet’s Control State.,The C(querier_ip) option is used to treat the gateway_ip as an IGMP querier source IP.,The C(nd_ra) option is used to treate the gateway_ip address as a Neighbor Discovery Router Advertisement Prefix.,The C(no_gw) option is used to remove default gateway functionality from the gateway address.,The APIC defaults to C(nd_ra) when unset during creation.



49
 
# File 'lib/ansible/ruby/modules/generated/network/aci/aci_bd_subnet.rb', line 49

attribute :subnet_control

#subnet_name ⇒ String?

Returns The name of the Subnet.

Returns:

  • (String, nil) —

    The name of the Subnet.



53
 
# File 'lib/ansible/ruby/modules/generated/network/aci/aci_bd_subnet.rb', line 53

attribute :subnet_name

#tenant ⇒ String?

Returns The name of the Tenant.

Returns:

  • (String, nil) —

    The name of the Tenant.



57
 
# File 'lib/ansible/ruby/modules/generated/network/aci/aci_bd_subnet.rb', line 57

attribute :tenant