Class: Ansible::Ruby::Modules::Ucs_vsans

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

Overview

Configures VSANs 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 VSAN. This can be one of the following:,common - The VSAN maps to the same VSAN ID in all available fabrics.,A - The VSAN maps to the a VSAN ID that exists only in fabric A.,B - The VSAN maps to the a VSAN ID that exists only in fabric B.

Returns:

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

    The fabric configuration of the VSAN. This can be one of the following:,common - The VSAN maps to the same VSAN ID in all available fabrics.,A - The VSAN maps to the a VSAN ID that exists only in fabric A.,B - The VSAN maps to the a VSAN ID that exists only in fabric B.



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

attribute :fabric

#fc_zoning:disabled, ...

Returns Fibre Channel zoning configuration for the Cisco UCS domain.,Fibre Channel zoning can be set to one of the following values:,disabled — The upstream switch handles Fibre Channel zoning, or Fibre Channel zoning is not implemented for the Cisco UCS domain.,enabled — Cisco UCS Manager configures and controls Fibre Channel zoning for the Cisco UCS domain.,If you enable Fibre Channel zoning, do not configure the upstream switch with any VSANs that are being used for Fibre Channel zoning.

Returns:

  • (:disabled, :enabled, nil)

    Fibre Channel zoning configuration for the Cisco UCS domain.,Fibre Channel zoning can be set to one of the following values:,disabled — The upstream switch handles Fibre Channel zoning, or Fibre Channel zoning is not implemented for the Cisco UCS domain.,enabled — Cisco UCS Manager configures and controls Fibre Channel zoning for the Cisco UCS domain.,If you enable Fibre Channel zoning, do not configure the upstream switch with any VSANs that are being used for Fibre Channel zoning.



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

attribute :fc_zoning

#nameString

Returns The name assigned to the VSAN.,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 VSAN is created.

Returns:

  • (String)

    The name assigned to the VSAN.,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 VSAN is created.



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

attribute :name

#state:present, ...

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

Returns:

  • (:present, :absent, nil)

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



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

attribute :state

#vlan_idString

Returns The unique string identifier assigned to the VLAN used for Fibre Channel connections.,Note that Cisco UCS Manager uses VLAN ‘4048’. See the UCS Manager configuration guide if you want to assign ‘4048’ to a VLAN.,Optional if state is absent.

Returns:

  • (String)

    The unique string identifier assigned to the VLAN used for Fibre Channel connections.,Note that Cisco UCS Manager uses VLAN ‘4048’. See the UCS Manager configuration guide if you want to assign ‘4048’ to a VLAN.,Optional if state is absent.



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

attribute :vlan_id

#vsan_idString

Returns The unique identifier assigned to the VSAN.,The ID can be a string between ‘1’ and ‘4078’, or between ‘4080’ and ‘4093’. ‘4079’ is a reserved VSAN ID.,In addition, if you plan to use FC end-host mode, the range between ‘3840’ to ‘4079’ is also a reserved VSAN ID range.,Optional if state is absent.

Returns:

  • (String)

    The unique identifier assigned to the VSAN.,The ID can be a string between ‘1’ and ‘4078’, or between ‘4080’ and ‘4093’. ‘4079’ is a reserved VSAN ID.,In addition, if you plan to use FC end-host mode, the range between ‘3840’ to ‘4079’ is also a reserved VSAN ID range.,Optional if state is absent.



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

attribute :vsan_id