Class: Ansible::Ruby::Modules::Os_ironic

Inherits:

Base

• Object
• Ansible::Ruby::Models::Base
• Base
• Ansible::Ruby::Modules::Os_ironic

Defined in:

lib/ansible/ruby/modules/generated/cloud/openstack/os_ironic.rb

Overview

Create or Remove Ironic nodes from OpenStack.

Instance Method Summary

• #availability_zone ⇒ Object^?

  Ignored.

• #chassis_uuid ⇒ String^?

  Associate the node with a pre-defined chassis.

• #driver ⇒ String

  The name of the Ironic Driver to use with this node.

• #driver_info ⇒ Hash^?

  Information for this server’s driver.

• #ironic_url ⇒ Object^?

  If noauth mode is utilized, this is required to be set to the endpoint URL for the Ironic API.

• #name ⇒ Object^?

  Unique name identifier to be given to the resource.

• #nics ⇒ Array<Hash>, Hash

  A list of network interface cards, eg, “ - mac: aa:bb:cc:aa:bb:cc”.

• #properties ⇒ Hash^?

  Definition of the physical characteristics of this server, used for scheduling purposes.

• #skip_update_of_driver_password ⇒ :yes, ...

  Allows the code that would assert changes to nodes to skip the update if the change is a single line consisting of the password field.

• #state ⇒ :present, ...

  Indicates desired state of the resource.

• #uuid ⇒ String^?

  Globally unique identifier (UUID) to be given to the resource.

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

#availability_zone ⇒ Object^?

Returns Ignored. Present for backwards compatibility.

Returns:

• (Object, nil) —

  Ignored. Present for backwards compatibility

# File 'lib/ansible/ruby/modules/generated/cloud/openstack/os_ironic.rb', line 50

attribute :availability_zone

#chassis_uuid ⇒ String^?

Returns Associate the node with a pre-defined chassis.

Returns:

• (String, nil) —

  Associate the node with a pre-defined chassis.

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

attribute :chassis_uuid

#driver ⇒ String

Returns The name of the Ironic Driver to use with this node.

Returns:

• (String) —

  The name of the Ironic Driver to use with this node.

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

attribute :driver

#driver_info ⇒ Hash^?

Returns Information for this server’s driver. Will vary based on which driver is in use. Any sub-field which is populated will be validated during creation.

Returns:

• (Hash, nil) —

  Information for this server’s driver. Will vary based on which driver is in use. Any sub-field which is populated will be validated during creation.

# File 'lib/ansible/ruby/modules/generated/cloud/openstack/os_ironic.rb', line 34

attribute :driver_info

#ironic_url ⇒ Object^?

Returns If noauth mode is utilized, this is required to be set to the endpoint URL for the Ironic API. Use with “auth” and “auth_type” settings set to None.

Returns:

• (Object, nil) —

  If noauth mode is utilized, this is required to be set to the endpoint URL for the Ironic API. Use with “auth” and “auth_type” settings set to None.

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

attribute :ironic_url

#name ⇒ Object^?

Returns unique name identifier to be given to the resource.

Returns:

• (Object, nil) —

  unique name identifier to be given to the resource.

# File 'lib/ansible/ruby/modules/generated/cloud/openstack/os_ironic.rb', line 20

attribute :name

#nics ⇒ Array<Hash>, Hash

Returns A list of network interface cards, eg, “ - mac: aa:bb:cc:aa:bb:cc”.

Returns:

• (Array<Hash>, Hash) —

  A list of network interface cards, eg, “ - mac: aa:bb:cc:aa:bb:cc”

# File 'lib/ansible/ruby/modules/generated/cloud/openstack/os_ironic.rb', line 38

attribute :nics

#properties ⇒ Hash^?

Returns Definition of the physical characteristics of this server, used for scheduling purposes.

Returns:

• (Hash, nil) —

  Definition of the physical characteristics of this server, used for scheduling purposes

# File 'lib/ansible/ruby/modules/generated/cloud/openstack/os_ironic.rb', line 42

attribute :properties

#skip_update_of_driver_password ⇒ :yes, ...

Returns Allows the code that would assert changes to nodes to skip the update if the change is a single line consisting of the password field. As of Kilo, by default, passwords are always masked to API requests, which means the logic as a result always attempts to re-assert the password field.

Returns:

• (:yes, :no, nil) —

  Allows the code that would assert changes to nodes to skip the update if the change is a single line consisting of the password field. As of Kilo, by default, passwords are always masked to API requests, which means the logic as a result always attempts to re-assert the password field.

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

attribute :skip_update_of_driver_password

#state ⇒ :present, ...

Returns Indicates desired state of the resource.

Returns:

• (:present, :absent, nil) —

  Indicates desired state of the resource

# File 'lib/ansible/ruby/modules/generated/cloud/openstack/os_ironic.rb', line 12

attribute :state

#uuid ⇒ String^?

Returns globally unique identifier (UUID) to be given to the resource. Will be auto-generated if not specified, and name is specified.,Definition of a UUID will always take precedence to a name value.

Returns:

• (String, nil) —

  globally unique identifier (UUID) to be given to the resource. Will be auto-generated if not specified, and name is specified.,Definition of a UUID will always take precedence to a name value.

# File 'lib/ansible/ruby/modules/generated/cloud/openstack/os_ironic.rb', line 16

attribute :uuid