Class: Ansible::Ruby::Modules::Ucs_vlans

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/remote_management/ucs/ucs_vlans.rb

Overview

Configures VLANs on Cisco UCS Manager. Examples can be used with the UCS Platform Emulator U(communities.cisco.com/ucspe).

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

#fabric ⇒ :common, ...

Returns The fabric configuration of the VLAN. This can be one of the following:,common - The VLAN applies to both fabrics and uses the same configuration parameters in both cases.,A — The VLAN only applies to fabric A.,B — The VLAN only applies to fabric B.,For upstream disjoint L2 networks, Cisco recommends that you choose common to create VLANs that apply to both fabrics.

Returns:

  • (:common, :A, :B, nil) —

    The fabric configuration of the VLAN. This can be one of the following:,common - The VLAN applies to both fabrics and uses the same configuration parameters in both cases.,A — The VLAN only applies to fabric A.,B — The VLAN only applies to fabric B.,For upstream disjoint L2 networks, Cisco recommends that you choose common to create VLANs that apply to both fabrics.



25
 
# File 'lib/ansible/ruby/modules/generated/remote_management/ucs/ucs_vlans.rb', line 25

attribute :fabric

#id ⇒ String

Returns The unique string identifier assigned to the VLAN.,A VLAN ID can be between ‘1’ and ‘3967’, or between ‘4048’ and ‘4093’.,You cannot create VLANs with IDs from 4030 to 4047. This range of VLAN IDs is reserved.,The VLAN IDs you specify must also be supported on the switch that you are using.,VLANs in the LAN cloud and FCoE VLANs in the SAN cloud must have different IDs.,Optional if state is absent.

Returns:

  • (String) —

    The unique string identifier assigned to the VLAN.,A VLAN ID can be between ‘1’ and ‘3967’, or between ‘4048’ and ‘4093’.,You cannot create VLANs with IDs from 4030 to 4047. This range of VLAN IDs is reserved.,The VLAN IDs you specify must also be supported on the switch that you are using.,VLANs in the LAN cloud and FCoE VLANs in the SAN cloud must have different IDs.,Optional if state is absent.



29
 
# File 'lib/ansible/ruby/modules/generated/remote_management/ucs/ucs_vlans.rb', line 29

attribute :id

#multicast_policy ⇒ String?

Returns The multicast policy associated with this VLAN.,This option is only valid if the Sharing Type field is set to None or Primary.

Returns:

  • (String, nil) —

    The multicast policy associated with this VLAN.,This option is only valid if the Sharing Type field is set to None or Primary.



21
 
# File 'lib/ansible/ruby/modules/generated/remote_management/ucs/ucs_vlans.rb', line 21

attribute :multicast_policy

#name ⇒ String

Returns The name assigned to the VLAN.,The VLAN name is case sensitive.,This name can be between 1 and 32 alphanumeric characters.,You cannot use spaces or any special characters other than - (hyphen), “_” (underscore), : (colon), and . (period).,You cannot change this name after the VLAN is created.

Returns:

  • (String) —

    The name assigned to the VLAN.,The VLAN name is case sensitive.,This name can be between 1 and 32 alphanumeric characters.,You cannot use spaces or any special characters other than - (hyphen), “_” (underscore), : (colon), and . (period).,You cannot change this name after the VLAN is created.



17
 
# File 'lib/ansible/ruby/modules/generated/remote_management/ucs/ucs_vlans.rb', line 17

attribute :name

#native ⇒ :yes, ...

Returns Designates the VLAN as a native VLAN.

Returns:

  • (:yes, :no, nil) —

    Designates the VLAN as a native VLAN.



37
 
# File 'lib/ansible/ruby/modules/generated/remote_management/ucs/ucs_vlans.rb', line 37

attribute :native

#sharing ⇒ :none, ...

Returns The Sharing Type field.,Whether this VLAN is subdivided into private or secondary VLANs. This can be one of the following:,none - This VLAN does not have any secondary or private VLANs. This is a regular VLAN.,primary - This VLAN can have one or more secondary VLANs, as shown in the Secondary VLANs area. This VLAN is a primary VLAN in the private VLAN domain.,isolated - This is a private VLAN associated with a primary VLAN. This VLAN is an Isolated VLAN.,community - This VLAN can communicate with other ports on the same community VLAN as well as the promiscuous port. This VLAN is a Community VLAN.

Returns:

  • (:none, :primary, :isolated, :community, nil) —

    The Sharing Type field.,Whether this VLAN is subdivided into private or secondary VLANs. This can be one of the following:,none - This VLAN does not have any secondary or private VLANs. This is a regular VLAN.,primary - This VLAN can have one or more secondary VLANs, as shown in the Secondary VLANs area. This VLAN is a primary VLAN in the private VLAN domain.,isolated - This is a private VLAN associated with a primary VLAN. This VLAN is an Isolated VLAN.,community - This VLAN can communicate with other ports on the same community VLAN as well as the promiscuous port. This VLAN is a Community VLAN.



33
 
# File 'lib/ansible/ruby/modules/generated/remote_management/ucs/ucs_vlans.rb', line 33

attribute :sharing

#state ⇒ :present, ...

Returns If C(present), will verify VLANs are present and will create if needed.,If C(absent), will verify VLANs are absent and will delete if needed.

Returns:

  • (:present, :absent, nil) —

    If C(present), will verify VLANs are present and will create if needed.,If C(absent), will verify VLANs are absent and will delete if needed.



13
 
# File 'lib/ansible/ruby/modules/generated/remote_management/ucs/ucs_vlans.rb', line 13

attribute :state