Class: Ansible::Ruby::Modules::Dimensiondata_vlan

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/cloud/dimensiondata/dimensiondata_vlan.rb

Overview

Manage VLANs in Cloud Control network domains.

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

#allow_expand ⇒ :yes, ...

Returns Permit expansion of the target VLAN’s network if the module parameters specify a larger network than the VLAN currently posesses?,If C(False), the module will fail under these conditions.,This is intended to prevent accidental expansion of a VLAN’s network (since this operation is not reversible).

Returns:

  • (:yes, :no, nil) —

    Permit expansion of the target VLAN’s network if the module parameters specify a larger network than the VLAN currently posesses?,If C(False), the module will fail under these conditions.,This is intended to prevent accidental expansion of a VLAN’s network (since this operation is not reversible).



36
 
# File 'lib/ansible/ruby/modules/generated/cloud/dimensiondata/dimensiondata_vlan.rb', line 36

attribute :allow_expand

#description ⇒ String?

Returns A description of the VLAN.

Returns:

  • (String, nil) —

    A description of the VLAN.



16
 
# File 'lib/ansible/ruby/modules/generated/cloud/dimensiondata/dimensiondata_vlan.rb', line 16

attribute :description

#name ⇒ String?

Returns The name of the target VLAN.,Required if C(state) is C(present).

Returns:

  • (String, nil) —

    The name of the target VLAN.,Required if C(state) is C(present).



12
 
# File 'lib/ansible/ruby/modules/generated/cloud/dimensiondata/dimensiondata_vlan.rb', line 12

attribute :name

#network_domain ⇒ String

Returns The Id or name of the target network domain.

Returns:

  • (String) —

    The Id or name of the target network domain.



20
 
# File 'lib/ansible/ruby/modules/generated/cloud/dimensiondata/dimensiondata_vlan.rb', line 20

attribute :network_domain

#private_ipv4_base_address ⇒ String?

Returns The base address for the VLAN’s IPv4 network (e.g. 192.168.1.0).

Returns:

  • (String, nil) —

    The base address for the VLAN’s IPv4 network (e.g. 192.168.1.0).



24
 
# File 'lib/ansible/ruby/modules/generated/cloud/dimensiondata/dimensiondata_vlan.rb', line 24

attribute :private_ipv4_base_address

#private_ipv4_prefix_size ⇒ Integer?

Returns The size of the IPv4 address space, e.g 24.,Required, if C(private_ipv4_base_address) is specified.

Returns:

  • (Integer, nil) —

    The size of the IPv4 address space, e.g 24.,Required, if C(private_ipv4_base_address) is specified.



28
 
# File 'lib/ansible/ruby/modules/generated/cloud/dimensiondata/dimensiondata_vlan.rb', line 28

attribute :private_ipv4_prefix_size

#state ⇒ :present, ...

Returns The desired state for the target VLAN.,C(readonly) ensures that the state is only ever read, not modified (the module will fail if the resource does not exist).

Returns:

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

    The desired state for the target VLAN.,C(readonly) ensures that the state is only ever read, not modified (the module will fail if the resource does not exist).



32
 
# File 'lib/ansible/ruby/modules/generated/cloud/dimensiondata/dimensiondata_vlan.rb', line 32

attribute :state