Class: Ansible::Ruby::Modules::Os_floating_ip

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

Overview

Add or Remove a floating IP to an instance

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

#fixed_address ⇒ String?

Returns To which fixed IP of server the floating IP address should be attached to.

Returns:

  • (String, nil) —

    To which fixed IP of server the floating IP address should be attached to.



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

attribute :fixed_address

#floating_ip_address ⇒ String?

Returns A floating IP address to attach or to detach. Required only if I(state) is absent. When I(state) is present can be used to specify a IP address to attach.

Returns:

  • (String, nil) —

    A floating IP address to attach or to detach. Required only if I(state) is absent. When I(state) is present can be used to specify a IP address to attach.



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

attribute :floating_ip_address

#network ⇒ String?

Returns The name or ID of a neutron external network or a nova pool name.

Returns:

  • (String, nil) —

    The name or ID of a neutron external network or a nova pool name.



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

attribute :network

#purge ⇒ Boolean?

Returns When I(state) is absent, indicates whether or not to delete the floating IP completely, or only detach it from the server. Default is to detach only.

Returns:

  • (Boolean, nil) —

    When I(state) is absent, indicates whether or not to delete the floating IP completely, or only detach it from the server. Default is to detach only.



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

attribute :purge

#reuse ⇒ Boolean?

Returns When I(state) is present, and I(floating_ip_address) is not present, this parameter can be used to specify whether we should try to reuse a floating IP address already allocated to the project.

Returns:

  • (Boolean, nil) —

    When I(state) is present, and I(floating_ip_address) is not present, this parameter can be used to specify whether we should try to reuse a floating IP address already allocated to the project.



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

attribute :reuse

#server ⇒ String

Returns The name or ID of the instance to which the IP address should be assigned.

Returns:

  • (String) —

    The name or ID of the instance to which the IP address should be assigned.



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

attribute :server

#state ⇒ :present, ...

Returns Should the resource be present or absent.

Returns:

  • (:present, :absent, nil) —

    Should the resource be present or absent.



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

attribute :state

#timeout ⇒ Integer?

Returns Time to wait for an IP address to appear as attached. See wait.

Returns:

  • (Integer, nil) —

    Time to wait for an IP address to appear as attached. See wait.



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

attribute :timeout

#wait ⇒ Boolean?

Returns When attaching a floating IP address, specify whether we should wait for it to appear as attached.

Returns:

  • (Boolean, nil) —

    When attaching a floating IP address, specify whether we should wait for it to appear as attached.



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

attribute :wait