Class: Ansible::Ruby::Modules::Os_port

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/core/cloud/openstack/os_port.rb

Overview

Add, Update or Remove ports from an OpenStack cloud. A I(state) of ‘present’ will ensure the port is created or updated if required.

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

#admin_state_up ⇒ Object?

Returns Sets admin state.

Returns:

  • (Object, nil) —

    Sets admin state.



23
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/openstack/os_port.rb', line 23

attribute :admin_state_up

#allowed_address_pairs ⇒ Object?

Returns Allowed address pairs list. Allowed address pairs are supported with dictionary structure. e.g. allowed_address_pairs: - ip_address: 10.1.0.12 mac_address: ab:cd:ef:12:34:56 - ip_address: …

Returns:

  • (Object, nil) —

    Allowed address pairs list. Allowed address pairs are supported with dictionary structure. e.g. allowed_address_pairs: - ip_address: 10.1.0.12 mac_address: ab:cd:ef:12:34:56 - ip_address: …



37
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/openstack/os_port.rb', line 37

attribute :allowed_address_pairs

#device_id ⇒ Object?

Returns Device ID of device using this port.

Returns:

  • (Object, nil) —

    Device ID of device using this port.



46
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/openstack/os_port.rb', line 46

attribute :device_id

#device_owner ⇒ Object?

Returns The ID of the entity that uses this port.

Returns:

  • (Object, nil) —

    The ID of the entity that uses this port.



43
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/openstack/os_port.rb', line 43

attribute :device_owner

#extra_dhcp_opts ⇒ Object?

Returns Extra dhcp options to be assigned to this port. Extra options are supported with dictionary structure. e.g. extra_dhcp_opts: - opt_name: opt name1 opt_value: value1 - opt_name: …

Returns:

  • (Object, nil) —

    Extra dhcp options to be assigned to this port. Extra options are supported with dictionary structure. e.g. extra_dhcp_opts: - opt_name: opt name1 opt_value: value1 - opt_name: …



40
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/openstack/os_port.rb', line 40

attribute :extra_dhcp_opts

#fixed_ips ⇒ Array<Hash>, ...

Returns Desired IP and/or subnet for this port. Subnet is referenced by subnet_id and IP is referenced by ip_address.

Returns:

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

    Desired IP and/or subnet for this port. Subnet is referenced by subnet_id and IP is referenced by ip_address.



19
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/openstack/os_port.rb', line 19

attribute :fixed_ips

#mac_address ⇒ Object?

Returns MAC address of this port.

Returns:

  • (Object, nil) —

    MAC address of this port.



26
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/openstack/os_port.rb', line 26

attribute :mac_address

#name ⇒ String?

Returns Name that has to be given to the port.

Returns:

  • (String, nil) —

    Name that has to be given to the port.



15
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/openstack/os_port.rb', line 15

attribute :name

#network ⇒ String

Returns Network ID or name this port belongs to.

Returns:

  • (String) —

    Network ID or name this port belongs to.



11
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/openstack/os_port.rb', line 11

attribute :network

#no_security_groups ⇒ Boolean?

Returns Do not associate a security group with this port.

Returns:

  • (Boolean, nil) —

    Do not associate a security group with this port.



33
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/openstack/os_port.rb', line 33

attribute :no_security_groups

#security_groups ⇒ Array<String>, ...

Returns Security group(s) ID(s) or name(s) associated with the port (comma separated string or YAML list).

Returns:

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

    Security group(s) ID(s) or name(s) associated with the port (comma separated string or YAML list)



29
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/openstack/os_port.rb', line 29

attribute :security_groups

#state ⇒ :present, ...

Returns Should the resource be present or absent.

Returns:

  • (:present, :absent, nil) —

    Should the resource be present or absent.



49
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/openstack/os_port.rb', line 49

attribute :state