Class: Ansible::Ruby::Modules::Os_ironic_node

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

Overview

Deploy to nodes controlled by Ironic.

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

#availability_zone ⇒ Object?

Returns Ignored. Present for backwards compatibility.

Returns:

  • (Object, nil) —

    Ignored. Present for backwards compatibility



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

attribute :availability_zone

#config_drive ⇒ Object?

Returns A configdrive file or HTTP(S) URL that will be passed along to the node.

Returns:

  • (Object, nil) —

    A configdrive file or HTTP(S) URL that will be passed along to the node.



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

attribute :config_drive

#deploy ⇒ :yes, ...

Returns Indicates if the resource should be deployed. Allows for deployment logic to be disengaged and control of the node power or maintenance state to be changed.

Returns:

  • (:yes, :no, nil) —

    Indicates if the resource should be deployed. Allows for deployment logic to be disengaged and control of the node power or maintenance state to be changed.



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

attribute :deploy

#instance_info ⇒ Object?

Returns Definition of the instance information which is used to deploy the node. This information is only required when an instance is set to present.

Returns:

  • (Object, nil) —

    Definition of the instance information which is used to deploy the node. This information is only required when an instance is set to present.



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

attribute :instance_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.



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

attribute :ironic_url

#maintenance ⇒ :yes, ...

Returns A setting to allow the direct control if a node is in maintenance mode.

Returns:

  • (:yes, :no, nil) —

    A setting to allow the direct control if a node is in maintenance mode.



36
 
# File 'lib/ansible/ruby/modules/generated/cloud/openstack/os_ironic_node.rb', line 36

attribute :maintenance

#maintenance_reason ⇒ Object?

Returns A string expression regarding the reason a node is in a maintenance mode.

Returns:

  • (Object, nil) —

    A string expression regarding the reason a node is in a maintenance mode.



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

attribute :maintenance_reason

#power ⇒ :present, ...

Returns A setting to allow power state to be asserted allowing nodes that are not yet deployed to be powered on, and nodes that are deployed to be powered off.

Returns:

  • (:present, :absent, nil) —

    A setting to allow power state to be asserted allowing nodes that are not yet deployed to be powered on, and nodes that are deployed to be powered off.



32
 
# File 'lib/ansible/ruby/modules/generated/cloud/openstack/os_ironic_node.rb', line 32

attribute :power

#state ⇒ :present, ...

Returns Indicates desired state of the resource.

Returns:

  • (:present, :absent, nil) —

    Indicates desired state of the resource



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

attribute :state

#timeout ⇒ Object?

Returns An integer value representing the number of seconds to wait for the node activation or deactivation to complete.

Returns:

  • (Object, nil) —

    An integer value representing the number of seconds to wait for the node activation or deactivation to complete.



47
 
# File 'lib/ansible/ruby/modules/generated/cloud/openstack/os_ironic_node.rb', line 47

attribute :timeout

#uuid ⇒ Object?

Returns globally unique identifier (UUID) to be given to the resource.

Returns:

  • (Object, nil) —

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



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

attribute :uuid

#wait ⇒ :yes, ...

Returns A boolean value instructing the module to wait for node activation or deactivation to complete before returning.

Returns:

  • (:yes, :no, nil) —

    A boolean value instructing the module to wait for node activation or deactivation to complete before returning.



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

attribute :wait