Class: Ansible::Ruby::Modules::Vmware_portgroup

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

Overview

Create a VMware portgroup on given host/s or hosts of given cluster

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

#cluster_name ⇒ String?

Returns Name of cluster name for host membership.,Portgroup will be created on all hosts of the given cluster.,This option is required if C(hosts) is not specified.

Returns:

  • (String, nil) —

    Name of cluster name for host membership.,Portgroup will be created on all hosts of the given cluster.,This option is required if C(hosts) is not specified.



32
 
# File 'lib/ansible/ruby/modules/generated/cloud/vmware/vmware_portgroup.rb', line 32

attribute :cluster_name

#hosts ⇒ Array<String>, ...

Returns List of name of host or hosts on which portgroup needs to be added.,This option is required if C(cluster_name) is not specified.

Returns:

  • (Array<String>, String, nil) —

    List of name of host or hosts on which portgroup needs to be added.,This option is required if C(cluster_name) is not specified.



36
 
# File 'lib/ansible/ruby/modules/generated/cloud/vmware/vmware_portgroup.rb', line 36

attribute :hosts

#network_policy ⇒ Array<String>, ...

Returns Network policy specifies layer 2 security settings for a portgroup such as promiscuous mode, where guest adapter listens to all the packets, MAC address changes and forged transmits.,Dict which configures the different security values for portgroup.,Valid attributes are:,- C(promiscuous_mode) (bool): indicates whether promiscuous mode is allowed. (default: false),- C(forged_transmits) (bool): indicates whether forged transmits are allowed. (default: false),- C(mac_changes) (bool): indicates whether mac changes are allowed. (default: false).

Returns:

  • (Array<String>, String, nil) —

    Network policy specifies layer 2 security settings for a portgroup such as promiscuous mode, where guest adapter listens to all the packets, MAC address changes and forged transmits.,Dict which configures the different security values for portgroup.,Valid attributes are:,- C(promiscuous_mode) (bool): indicates whether promiscuous mode is allowed. (default: false),- C(forged_transmits) (bool): indicates whether forged transmits are allowed. (default: false),- C(mac_changes) (bool): indicates whether mac changes are allowed. (default: false)



24
 
# File 'lib/ansible/ruby/modules/generated/cloud/vmware/vmware_portgroup.rb', line 24

attribute :network_policy

#portgroup_name ⇒ String

Returns Portgroup name to add.

Returns:

  • (String) —

    Portgroup name to add.



16
 
# File 'lib/ansible/ruby/modules/generated/cloud/vmware/vmware_portgroup.rb', line 16

attribute :portgroup_name

#state ⇒ :present, ...

Returns Determines if the portgroup should be present or not.

Returns:

  • (:present, :absent, nil) —

    Determines if the portgroup should be present or not.



40
 
# File 'lib/ansible/ruby/modules/generated/cloud/vmware/vmware_portgroup.rb', line 40

attribute :state

#switch_name ⇒ String

Returns vSwitch to modify.

Returns:

  • (String) —

    vSwitch to modify.



12
 
# File 'lib/ansible/ruby/modules/generated/cloud/vmware/vmware_portgroup.rb', line 12

attribute :switch_name

#teaming_policy ⇒ Array<String>, ...

Returns Dictionary which configures the different teaming values for portgroup.,Valid attributes are:,- C(load_balance_policy) (string): Network adapter teaming policy. (default: loadbalance_srcid), - choices: [ loadbalance_ip, loadbalance_srcmac, loadbalance_srcid, failover_explicit ],- C(inbound_policy) (bool): Indicate whether or not the teaming policy is applied to inbound frames as well. (default: False),- C(notify_switches) (bool): Indicate whether or not to notify the physical switch if a link fails. (default: True),- C(rolling_order) (bool): Indicate whether or not to use a rolling policy when restoring links. (default: False).

Returns:

  • (Array<String>, String, nil) —

    Dictionary which configures the different teaming values for portgroup.,Valid attributes are:,- C(load_balance_policy) (string): Network adapter teaming policy. (default: loadbalance_srcid), - choices: [ loadbalance_ip, loadbalance_srcmac, loadbalance_srcid, failover_explicit ],- C(inbound_policy) (bool): Indicate whether or not the teaming policy is applied to inbound frames as well. (default: False),- C(notify_switches) (bool): Indicate whether or not to notify the physical switch if a link fails. (default: True),- C(rolling_order) (bool): Indicate whether or not to use a rolling policy when restoring links. (default: False)



28
 
# File 'lib/ansible/ruby/modules/generated/cloud/vmware/vmware_portgroup.rb', line 28

attribute :teaming_policy

#vlan_id ⇒ String

Returns VLAN ID to assign to portgroup.

Returns:

  • (String) —

    VLAN ID to assign to portgroup.



20
 
# File 'lib/ansible/ruby/modules/generated/cloud/vmware/vmware_portgroup.rb', line 20

attribute :vlan_id