ironicclient.osc.v1.baremetal_node module

class ironicclient.osc.v1.baremetal_node.AbortBaremetalNode(app, app_args, cmd_name=None)[source]

Bases: ProvisionStateBaremetalNode

Set provision state of baremetal node to ‘abort’

PROVISION_STATE = 'abort'
log = <Logger ironicclient.osc.v1.baremetal_node.AbortBaremetalNode (WARNING)>
class ironicclient.osc.v1.baremetal_node.AddTraitBaremetalNode(app, app_args, cmd_name=None)[source]

Bases: Command

Add traits to a node.

get_parser(prog_name)[source]

Return an argparse.ArgumentParser.

log = <Logger ironicclient.osc.v1.baremetal_node.AddTraitBaremetalNode (WARNING)>
take_action(parsed_args)[source]

Override to do something useful.

The returned value will be returned by the program.

class ironicclient.osc.v1.baremetal_node.AdoptBaremetalNode(app, app_args, cmd_name=None)[source]

Bases: ProvisionStateWithWait

Set provision state of baremetal node to ‘adopt’

PROVISION_STATE = 'adopt'
log = <Logger ironicclient.osc.v1.baremetal_node.AdoptBaremetalNode (WARNING)>
class ironicclient.osc.v1.baremetal_node.BIOSSettingShowBaremetalNode(app, app_args, cmd_name=None)[source]

Bases: ShowOne

Show a specific BIOS setting for a node.

get_parser(prog_name)[source]

Return an argparse.ArgumentParser.

log = <Logger ironicclient.osc.v1.baremetal_node.BIOSSettingShowBaremetalNode (WARNING)>
take_action(parsed_args)[source]

Return a two-part tuple with a tuple of column names and a tuple of values.

class ironicclient.osc.v1.baremetal_node.BootdeviceSetBaremetalNode(app, app_args, cmd_name=None)[source]

Bases: Command

Set the boot device for a node

get_parser(prog_name)[source]

Return an argparse.ArgumentParser.

log = <Logger ironicclient.osc.v1.baremetal_node.BootdeviceSetBaremetalNode (WARNING)>
take_action(parsed_args)[source]

Override to do something useful.

The returned value will be returned by the program.

class ironicclient.osc.v1.baremetal_node.BootdeviceShowBaremetalNode(app, app_args, cmd_name=None)[source]

Bases: ShowOne

Show the boot device information for a node

get_parser(prog_name)[source]

Return an argparse.ArgumentParser.

log = <Logger ironicclient.osc.v1.baremetal_node.BootdeviceShowBaremetalNode (WARNING)>
take_action(parsed_args)[source]

Return a two-part tuple with a tuple of column names and a tuple of values.

class ironicclient.osc.v1.baremetal_node.BootmodeSetBaremetalNode(app, app_args, cmd_name=None)[source]

Bases: Command

Set the boot mode for the next baremetal node deployment

get_parser(prog_name)[source]

Return an argparse.ArgumentParser.

log = <Logger ironicclient.osc.v1.baremetal_node.BootmodeSetBaremetalNode (WARNING)>
take_action(parsed_args)[source]

Override to do something useful.

The returned value will be returned by the program.

class ironicclient.osc.v1.baremetal_node.CleanBaremetalNode(app, app_args, cmd_name=None)[source]

Bases: ProvisionStateWithWait

Set provision state of baremetal node to ‘clean’

PROVISION_STATE = 'clean'
get_parser(prog_name)[source]

Return an argparse.ArgumentParser.

log = <Logger ironicclient.osc.v1.baremetal_node.CleanBaremetalNode (WARNING)>
class ironicclient.osc.v1.baremetal_node.ConsoleDisableBaremetalNode(app, app_args, cmd_name=None)[source]

Bases: Command

Disable console access for a node

get_parser(prog_name)[source]

Return an argparse.ArgumentParser.

log = <Logger ironicclient.osc.v1.baremetal_node.ConsoleDisableBaremetalNode (WARNING)>
take_action(parsed_args)[source]

Override to do something useful.

The returned value will be returned by the program.

class ironicclient.osc.v1.baremetal_node.ConsoleEnableBaremetalNode(app, app_args, cmd_name=None)[source]

Bases: Command

Enable console access for a node

get_parser(prog_name)[source]

Return an argparse.ArgumentParser.

log = <Logger ironicclient.osc.v1.baremetal_node.ConsoleEnableBaremetalNode (WARNING)>
take_action(parsed_args)[source]

Override to do something useful.

The returned value will be returned by the program.

class ironicclient.osc.v1.baremetal_node.ConsoleShowBaremetalNode(app, app_args, cmd_name=None)[source]

Bases: ShowOne

Show console information for a node

get_parser(prog_name)[source]

Return an argparse.ArgumentParser.

log = <Logger ironicclient.osc.v1.baremetal_node.ConsoleShowBaremetalNode (WARNING)>
take_action(parsed_args)[source]

Return a two-part tuple with a tuple of column names and a tuple of values.

class ironicclient.osc.v1.baremetal_node.CreateBaremetalNode(app, app_args, cmd_name=None)[source]

Bases: ShowOne

Register a new node with the baremetal service

get_parser(prog_name)[source]

Return an argparse.ArgumentParser.

log = <Logger ironicclient.osc.v1.baremetal_node.CreateBaremetalNode (WARNING)>
take_action(parsed_args)[source]

Return a two-part tuple with a tuple of column names and a tuple of values.

class ironicclient.osc.v1.baremetal_node.DeleteBaremetalNode(app, app_args, cmd_name=None)[source]

Bases: Command

Unregister baremetal node(s)

get_parser(prog_name)[source]

Return an argparse.ArgumentParser.

log = <Logger ironicclient.osc.v1.baremetal_node.DeleteBaremetalNode (WARNING)>
take_action(parsed_args)[source]

Override to do something useful.

The returned value will be returned by the program.

class ironicclient.osc.v1.baremetal_node.DeployBaremetalNode(app, app_args, cmd_name=None)[source]

Bases: ProvisionStateWithWait

Set provision state of baremetal node to ‘deploy’

PROVISION_STATE = 'active'
get_parser(prog_name)[source]

Return an argparse.ArgumentParser.

log = <Logger ironicclient.osc.v1.baremetal_node.DeployBaremetalNode (WARNING)>
class ironicclient.osc.v1.baremetal_node.InjectNmiBaremetalNode(app, app_args, cmd_name=None)[source]

Bases: Command

Inject NMI to baremetal node

get_parser(prog_name)[source]

Return an argparse.ArgumentParser.

log = <Logger ironicclient.osc.v1.baremetal_node.InjectNmiBaremetalNode (WARNING)>
take_action(parsed_args)[source]

Override to do something useful.

The returned value will be returned by the program.

class ironicclient.osc.v1.baremetal_node.InspectBaremetalNode(app, app_args, cmd_name=None)[source]

Bases: ProvisionStateWithWait

Set provision state of baremetal node to ‘inspect’

PROVISION_STATE = 'inspect'
log = <Logger ironicclient.osc.v1.baremetal_node.InspectBaremetalNode (WARNING)>
class ironicclient.osc.v1.baremetal_node.ListBIOSSettingBaremetalNode(app, app_args, cmd_name=None)[source]

Bases: Lister

List a node’s BIOS settings.

get_parser(prog_name)[source]

Return an argparse.ArgumentParser.

log = <Logger ironicclient.osc.v1.baremetal_node.ListBIOSSettingBaremetalNode (WARNING)>
take_action(parsed_args)[source]

Run command.

Return a tuple containing the column names and an iterable containing the data to be listed.

class ironicclient.osc.v1.baremetal_node.ListBaremetalNode(app, app_args, cmd_name=None)[source]

Bases: Lister

List baremetal nodes

PROVISION_STATES = ['active', 'deleted', 'rebuild', 'inspect', 'provide', 'manage', 'clean', 'adopt', 'abort']
get_parser(prog_name)[source]

Return an argparse.ArgumentParser.

log = <Logger ironicclient.osc.v1.baremetal_node.ListBaremetalNode (WARNING)>
take_action(parsed_args)[source]

Run command.

Return a tuple containing the column names and an iterable containing the data to be listed.

class ironicclient.osc.v1.baremetal_node.ListFirmwareComponentBaremetalNode(app, app_args, cmd_name=None)[source]

Bases: Lister

List all Firmware Components of a node

get_parser(prog_name)[source]

Return an argparse.ArgumentParser.

log = <Logger ironicclient.osc.v1.baremetal_node.ListFirmwareComponentBaremetalNode (WARNING)>
take_action(parsed_args)[source]

Run command.

Return a tuple containing the column names and an iterable containing the data to be listed.

class ironicclient.osc.v1.baremetal_node.ListTraitsBaremetalNode(app, app_args, cmd_name=None)[source]

Bases: Lister

List a node’s traits.

get_parser(prog_name)[source]

Return an argparse.ArgumentParser.

log = <Logger ironicclient.osc.v1.baremetal_node.ListTraitsBaremetalNode (WARNING)>
take_action(parsed_args)[source]

Run command.

Return a tuple containing the column names and an iterable containing the data to be listed.

class ironicclient.osc.v1.baremetal_node.MaintenanceSetBaremetalNode(app, app_args, cmd_name=None)[source]

Bases: Command

Set baremetal node to maintenance mode

get_parser(prog_name)[source]

Return an argparse.ArgumentParser.

log = <Logger ironicclient.osc.v1.baremetal_node.MaintenanceSetBaremetalNode (WARNING)>
take_action(parsed_args)[source]

Override to do something useful.

The returned value will be returned by the program.

class ironicclient.osc.v1.baremetal_node.MaintenanceUnsetBaremetalNode(app, app_args, cmd_name=None)[source]

Bases: Command

Unset baremetal node from maintenance mode

get_parser(prog_name)[source]

Return an argparse.ArgumentParser.

log = <Logger ironicclient.osc.v1.baremetal_node.MaintenanceUnsetBaremetalNode (WARNING)>
take_action(parsed_args)[source]

Override to do something useful.

The returned value will be returned by the program.

class ironicclient.osc.v1.baremetal_node.ManageBaremetalNode(app, app_args, cmd_name=None)[source]

Bases: ProvisionStateWithWait

Set provision state of baremetal node to ‘manage’

PROVISION_STATE = 'manage'
log = <Logger ironicclient.osc.v1.baremetal_node.ManageBaremetalNode (WARNING)>
class ironicclient.osc.v1.baremetal_node.NodeChildrenList(app, app_args, cmd_name=None)[source]

Bases: ShowOne

Get a list of nodes associated as children.

get_parser(prog_name)[source]

Return an argparse.ArgumentParser.

log = <Logger ironicclient.osc.v1.baremetal_node.NodeChildrenList (WARNING)>
take_action(parsed_args)[source]

Return a two-part tuple with a tuple of column names and a tuple of values.

class ironicclient.osc.v1.baremetal_node.NodeHistoryEventGet(app, app_args, cmd_name=None)[source]

Bases: ShowOne

Get history event for a baremetal node.

get_parser(prog_name)[source]

Return an argparse.ArgumentParser.

log = <Logger ironicclient.osc.v1.baremetal_node.NodeHistoryEventGet (WARNING)>
take_action(parsed_args)[source]

Return a two-part tuple with a tuple of column names and a tuple of values.

class ironicclient.osc.v1.baremetal_node.NodeHistoryList(app, app_args, cmd_name=None)[source]

Bases: Lister

Get history events for a baremetal node.

get_parser(prog_name)[source]

Return an argparse.ArgumentParser.

log = <Logger ironicclient.osc.v1.baremetal_node.NodeHistoryList (WARNING)>
take_action(parsed_args)[source]

Run command.

Return a tuple containing the column names and an iterable containing the data to be listed.

class ironicclient.osc.v1.baremetal_node.NodeInventorySave(app, app_args, cmd_name=None)[source]

Bases: Command

Get hardware inventory of a node (in JSON format) or save it to file.

get_parser(prog_name)[source]

Return an argparse.ArgumentParser.

log = <Logger ironicclient.osc.v1.baremetal_node.NodeInventorySave (WARNING)>
take_action(parsed_args)[source]

Override to do something useful.

The returned value will be returned by the program.

class ironicclient.osc.v1.baremetal_node.PassthruCallBaremetalNode(app, app_args, cmd_name=None)[source]

Bases: Command

Call a vendor passthru method for a node

get_parser(prog_name)[source]

Return an argparse.ArgumentParser.

log = <Logger ironicclient.osc.v1.baremetal_node.PassthruCallBaremetalNode (WARNING)>
take_action(parsed_args)[source]

Override to do something useful.

The returned value will be returned by the program.

class ironicclient.osc.v1.baremetal_node.PassthruListBaremetalNode(app, app_args, cmd_name=None)[source]

Bases: Lister

List vendor passthru methods for a node

get_parser(prog_name)[source]

Return an argparse.ArgumentParser.

log = <Logger ironicclient.osc.v1.baremetal_node.PassthruListBaremetalNode (WARNING)>
take_action(parsed_args)[source]

Run command.

Return a tuple containing the column names and an iterable containing the data to be listed.

class ironicclient.osc.v1.baremetal_node.PowerBaremetalNode(app, app_args, cmd_name=None)[source]

Bases: Command

Base power state class, for setting the power of a node

get_parser(prog_name)[source]

Return an argparse.ArgumentParser.

log = <Logger ironicclient.osc.v1.baremetal_node.PowerBaremetalNode (WARNING)>
take_action(parsed_args)[source]

Override to do something useful.

The returned value will be returned by the program.

class ironicclient.osc.v1.baremetal_node.PowerOffBaremetalNode(app, app_args, cmd_name=None)[source]

Bases: PowerBaremetalNode

Power off a node

POWER_STATE = 'off'
get_parser(prog_name)[source]

Return an argparse.ArgumentParser.

log = <Logger ironicclient.osc.v1.baremetal_node.PowerOffBaremetalNode (WARNING)>
class ironicclient.osc.v1.baremetal_node.PowerOnBaremetalNode(app, app_args, cmd_name=None)[source]

Bases: PowerBaremetalNode

Power on a node

POWER_STATE = 'on'
log = <Logger ironicclient.osc.v1.baremetal_node.PowerOnBaremetalNode (WARNING)>
class ironicclient.osc.v1.baremetal_node.ProvideBaremetalNode(app, app_args, cmd_name=None)[source]

Bases: ProvisionStateWithWait

Set provision state of baremetal node to ‘provide’

PROVISION_STATE = 'provide'
log = <Logger ironicclient.osc.v1.baremetal_node.ProvideBaremetalNode (WARNING)>
class ironicclient.osc.v1.baremetal_node.ProvisionStateBaremetalNode(app, app_args, cmd_name=None)[source]

Bases: Command

Base provision state class

get_parser(prog_name)[source]

Return an argparse.ArgumentParser.

log = <Logger ironicclient.osc.v1.baremetal_node.ProvisionStateBaremetalNode (WARNING)>
take_action(parsed_args)[source]

Override to do something useful.

The returned value will be returned by the program.

class ironicclient.osc.v1.baremetal_node.ProvisionStateWithWait(app, app_args, cmd_name=None)[source]

Bases: ProvisionStateBaremetalNode

Provision state class adding –wait flag.

get_parser(prog_name)[source]

Return an argparse.ArgumentParser.

log = <Logger ironicclient.osc.v1.baremetal_node.ProvisionStateWithWait (WARNING)>
take_action(parsed_args)[source]

Override to do something useful.

The returned value will be returned by the program.

class ironicclient.osc.v1.baremetal_node.RebootBaremetalNode(app, app_args, cmd_name=None)[source]

Bases: Command

Reboot baremetal node

get_parser(prog_name)[source]

Return an argparse.ArgumentParser.

log = <Logger ironicclient.osc.v1.baremetal_node.RebootBaremetalNode (WARNING)>
take_action(parsed_args)[source]

Override to do something useful.

The returned value will be returned by the program.

class ironicclient.osc.v1.baremetal_node.RebuildBaremetalNode(app, app_args, cmd_name=None)[source]

Bases: ProvisionStateWithWait

Set provision state of baremetal node to ‘rebuild’

PROVISION_STATE = 'rebuild'
get_parser(prog_name)[source]

Return an argparse.ArgumentParser.

log = <Logger ironicclient.osc.v1.baremetal_node.RebuildBaremetalNode (WARNING)>
class ironicclient.osc.v1.baremetal_node.RemoveTraitBaremetalNode(app, app_args, cmd_name=None)[source]

Bases: Command

Remove trait(s) from a node.

get_parser(prog_name)[source]

Return an argparse.ArgumentParser.

log = <Logger ironicclient.osc.v1.baremetal_node.RemoveTraitBaremetalNode (WARNING)>
take_action(parsed_args)[source]

Override to do something useful.

The returned value will be returned by the program.

class ironicclient.osc.v1.baremetal_node.RescueBaremetalNode(app, app_args, cmd_name=None)[source]

Bases: ProvisionStateWithWait

Set provision state of baremetal node to ‘rescue’

PROVISION_STATE = 'rescue'
get_parser(prog_name)[source]

Return an argparse.ArgumentParser.

log = <Logger ironicclient.osc.v1.baremetal_node.RescueBaremetalNode (WARNING)>
class ironicclient.osc.v1.baremetal_node.SecurebootOffBaremetalNode(app, app_args, cmd_name=None)[source]

Bases: Command

Turn secure boot off

get_parser(prog_name)[source]

Return an argparse.ArgumentParser.

log = <Logger ironicclient.osc.v1.baremetal_node.SecurebootOffBaremetalNode (WARNING)>
take_action(parsed_args)[source]

Override to do something useful.

The returned value will be returned by the program.

class ironicclient.osc.v1.baremetal_node.SecurebootOnBaremetalNode(app, app_args, cmd_name=None)[source]

Bases: Command

Turn secure boot on

get_parser(prog_name)[source]

Return an argparse.ArgumentParser.

log = <Logger ironicclient.osc.v1.baremetal_node.SecurebootOnBaremetalNode (WARNING)>
take_action(parsed_args)[source]

Override to do something useful.

The returned value will be returned by the program.

class ironicclient.osc.v1.baremetal_node.SetBaremetalNode(app, app_args, cmd_name=None)[source]

Bases: Command

Set baremetal properties

get_parser(prog_name)[source]

Return an argparse.ArgumentParser.

log = <Logger ironicclient.osc.v1.baremetal_node.SetBaremetalNode (WARNING)>
take_action(parsed_args)[source]

Override to do something useful.

The returned value will be returned by the program.

class ironicclient.osc.v1.baremetal_node.ShowBaremetalNode(app, app_args, cmd_name=None)[source]

Bases: ShowOne

Show baremetal node details

get_parser(prog_name)[source]

Return an argparse.ArgumentParser.

log = <Logger ironicclient.osc.v1.baremetal_node.ShowBaremetalNode (WARNING)>
take_action(parsed_args)[source]

Return a two-part tuple with a tuple of column names and a tuple of values.

class ironicclient.osc.v1.baremetal_node.UndeployBaremetalNode(app, app_args, cmd_name=None)[source]

Bases: ProvisionStateWithWait

Set provision state of baremetal node to ‘deleted’

PROVISION_STATE = 'deleted'
log = <Logger ironicclient.osc.v1.baremetal_node.UndeployBaremetalNode (WARNING)>
class ironicclient.osc.v1.baremetal_node.UnholdBaremetalNode(app, app_args, cmd_name=None)[source]

Bases: ProvisionStateBaremetalNode

Set provision state of baremetal node to ‘unhold’

PROVISION_STATE = 'unhold'
log = <Logger ironicclient.osc.v1.baremetal_node.UnholdBaremetalNode (WARNING)>
class ironicclient.osc.v1.baremetal_node.UnrescueBaremetalNode(app, app_args, cmd_name=None)[source]

Bases: ProvisionStateWithWait

Set provision state of baremetal node to ‘unrescue’

PROVISION_STATE = 'unrescue'
log = <Logger ironicclient.osc.v1.baremetal_node.UnrescueBaremetalNode (WARNING)>
class ironicclient.osc.v1.baremetal_node.UnsetBaremetalNode(app, app_args, cmd_name=None)[source]

Bases: Command

Unset baremetal properties

get_parser(prog_name)[source]

Return an argparse.ArgumentParser.

log = <Logger ironicclient.osc.v1.baremetal_node.UnsetBaremetalNode (WARNING)>
take_action(parsed_args)[source]

Override to do something useful.

The returned value will be returned by the program.

class ironicclient.osc.v1.baremetal_node.ValidateBaremetalNode(app, app_args, cmd_name=None)[source]

Bases: Lister

Validate a node’s driver interfaces

get_parser(prog_name)[source]

Return an argparse.ArgumentParser.

log = <Logger ironicclient.osc.v1.baremetal_node.ValidateBaremetalNode (WARNING)>
take_action(parsed_args)[source]

Run command.

Return a tuple containing the column names and an iterable containing the data to be listed.

class ironicclient.osc.v1.baremetal_node.VifAttachBaremetalNode(app, app_args, cmd_name=None)[source]

Bases: Command

Attach VIF to a given node

get_parser(prog_name)[source]

Return an argparse.ArgumentParser.

log = <Logger ironicclient.osc.v1.baremetal_node.VifAttachBaremetalNode (WARNING)>
take_action(parsed_args)[source]

Override to do something useful.

The returned value will be returned by the program.

class ironicclient.osc.v1.baremetal_node.VifDetachBaremetalNode(app, app_args, cmd_name=None)[source]

Bases: Command

Detach VIF from a given node

get_parser(prog_name)[source]

Return an argparse.ArgumentParser.

log = <Logger ironicclient.osc.v1.baremetal_node.VifDetachBaremetalNode (WARNING)>
take_action(parsed_args)[source]

Override to do something useful.

The returned value will be returned by the program.

class ironicclient.osc.v1.baremetal_node.VifListBaremetalNode(app, app_args, cmd_name=None)[source]

Bases: Lister

Show attached VIFs for a node

get_parser(prog_name)[source]

Return an argparse.ArgumentParser.

log = <Logger ironicclient.osc.v1.baremetal_node.VifListBaremetalNode (WARNING)>
take_action(parsed_args)[source]

Run command.

Return a tuple containing the column names and an iterable containing the data to be listed.