senlin¶

cluster action list¶

List actions.

openstack cluster action list
    [--format-config-file FORMAT_CONFIG]
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [--filters <"key1=value1;key2=value2...">]
    [--sort <key>[:<direction>]]
    [--limit <limit>]
    [--marker <id>]
    [--global-project]
    [--full-id]

--format-config-file <FORMAT_CONFIG>¶

Config file for the dict-to-csv formatter

--sort-column SORT_COLUMN¶

specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

--sort-ascending¶

sort the column(s) in ascending order

--sort-descending¶

sort the column(s) in descending order

--filters <"key1=value1;key2=value2...">¶

Filter parameters to apply on returned actions. This can be specified multiple times, or once with parameters separated by a semicolon. The valid filter keys are: [‘name’, ‘target’, ‘action’, ‘status’]. NOTICE: The value of ‘target’, if provided, must be a full ID.

--sort <key>[:<direction>]¶

Sorting option which is a string containing a list of keys separated by commas. Each key can be optionally appended by a sort direction (:asc or :desc). The valid sort keys are: [‘name’, ‘target’, ‘action’, ‘created_at’, ‘status’]

--limit <limit>¶

Limit the number of actions returned

--marker <id>¶

Only return actions that appear after the given action ID

--global-project¶

Whether actions from all projects should be listed. Default to False. Setting this to True may demand for an admin privilege

--full-id¶

Print full IDs in list

This command is provided by the python-senlinclient plugin.

cluster action show¶

Show detailed info about the specified action.

openstack cluster action show <action>

action¶

Name or ID of the action to show the details for

This command is provided by the python-senlinclient plugin.

cluster action update¶

Update an action.

openstack cluster action update [--status <status>] <action>

--status <status>¶

The new status for the action

action¶

ID of the action to update

This command is provided by the python-senlinclient plugin.

cluster build info¶

Retrieve build information.

openstack cluster build info

This command is provided by the python-senlinclient plugin.

cluster check¶

Check the cluster(s).

openstack cluster check
    [--format-config-file FORMAT_CONFIG]
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [--wait]
    <cluster>
    [<cluster> ...]

--format-config-file <FORMAT_CONFIG>¶

Config file for the dict-to-csv formatter

--sort-column SORT_COLUMN¶

specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

--sort-ascending¶

sort the column(s) in ascending order

--sort-descending¶

sort the column(s) in descending order

--wait¶

Wait for cluster check to complete

cluster¶

ID or name of cluster(s) to operate on.

This command is provided by the python-senlinclient plugin.

cluster collect¶

Collect attributes across a cluster.

openstack cluster collect
    [--format-config-file FORMAT_CONFIG]
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [--full-id]
    --path <path>
    <cluster>

--format-config-file <FORMAT_CONFIG>¶

Config file for the dict-to-csv formatter

--sort-column SORT_COLUMN¶

specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

--sort-ascending¶

sort the column(s) in ascending order

--sort-descending¶

sort the column(s) in descending order

--full-id¶

Print full IDs in list

--path <path>¶

JSON path expression for attribute to be collected

cluster¶

ID or name of cluster(s) to operate on.

This command is provided by the python-senlinclient plugin.

cluster create¶

Create the cluster.

openstack cluster create
    [--config <"key1=value1;key2=value2...">]
    [--min-size <min-size>]
    [--max-size <max-size>]
    [--desired-capacity <desired-capacity>]
    [--timeout <timeout>]
    [--metadata <"key1=value1;key2=value2...">]
    --profile <profile>
    [--wait]
    <cluster-name>

--config <"key1=value1;key2=value2...">¶

Configuration of the cluster. Default to {}. This can be specified multiple times, or once with key-value pairs separated by a semicolon.

--min-size <min-size>¶

Min size of the cluster. Default to 0

--max-size <max-size>¶

Max size of the cluster. Default to -1, means unlimited

--desired-capacity <desired-capacity>¶

Desired capacity of the cluster. Default to min_size if min_size is specified else 0.

--timeout <timeout>¶

Cluster creation timeout in seconds

--metadata <"key1=value1;key2=value2...">¶

Metadata values to be attached to the cluster. This can be specified multiple times, or once with key-value pairs separated by a semicolon.

--profile <profile>¶

Default profile Id or name used for this cluster

--wait¶

Wait for cluster creation to complete

cluster-name¶

Name of the cluster to create

This command is provided by the python-senlinclient plugin.

cluster delete¶

Delete the cluster(s).

openstack cluster delete
    [--force-delete]
    [--force]
    [--wait]
    <cluster>
    [<cluster> ...]

--force-delete¶

Force to delete cluster(s).

--force¶

Skip yes/no prompt (assume yes).

--wait¶

Wait for cluster delete to complete

cluster¶

Name or ID of cluster(s) to delete.

This command is provided by the python-senlinclient plugin.

cluster event list¶

List events.

openstack cluster event list
    [--format-config-file FORMAT_CONFIG]
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [--filters <"key1=value1;key2=value2...">]
    [--limit <limit>]
    [--marker <id>]
    [--sort <key>[:<direction>]]
    [--global-project]
    [--full-id]

--format-config-file <FORMAT_CONFIG>¶

Config file for the dict-to-csv formatter

--sort-column SORT_COLUMN¶

specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

--sort-ascending¶

sort the column(s) in ascending order

--sort-descending¶

sort the column(s) in descending order

--filters <"key1=value1;key2=value2...">¶

Filter parameters to apply on returned events. This can be specified multiple times, or once with parameters separated by a semicolon. The valid filter keys are: [‘level’, ‘otype’, ‘oid’ ,’cluster_id’, ‘oname’, ‘action’]. NOTICE: The value of ‘oid’ or ‘cluster_id’, if provided, must be a full ID.

--limit <limit>¶

Limit the number of events returned

--marker <id>¶

Only return events that appear after the given event ID

--sort <key>[:<direction>]¶

Sorting option which is a string containing a list of keys separated by commas. Each key can be optionally appended by a sort direction (:asc or :desc). The valid sort keys are: [‘timestamp’, ‘level’, ‘oid’, ‘otype’, ‘oname’, ‘action’, ‘status’]

--global-project¶

Whether events from all projects should be listed. Default to False. Setting this to True may demand for an admin privilege

--full-id¶

Print full IDs in list

This command is provided by the python-senlinclient plugin.

cluster event show¶

Show the event details.

openstack cluster event show <event>

event¶

ID of event to display details for

This command is provided by the python-senlinclient plugin.

cluster expand¶

Scale out a cluster by the specified number of nodes.

openstack cluster expand [--count <count>] [--wait] <cluster>

--count <count>¶

Number of nodes to be added to the specified cluster

--wait¶

Wait for cluster scale-out to complete

cluster¶

Name or ID of cluster to operate on

This command is provided by the python-senlinclient plugin.

cluster list¶

List clusters.

openstack cluster list
    [--format-config-file FORMAT_CONFIG]
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [--filters <"key1=value1;key2=value2...">]
    [--sort <key>[:<direction>]]
    [--limit <limit>]
    [--marker <id>]
    [--global-project]
    [--full-id]

--format-config-file <FORMAT_CONFIG>¶

Config file for the dict-to-csv formatter

--sort-column SORT_COLUMN¶

specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

--sort-ascending¶

sort the column(s) in ascending order

--sort-descending¶

sort the column(s) in descending order

--filters <"key1=value1;key2=value2...">¶

Filter parameters to apply on returned clusters. This can be specified multiple times, or once with parameters separated by a semicolon. The valid filter keys are: [‘status’, ‘name’]

--sort <key>[:<direction>]¶

Sorting option which is a string containing a list of keys separated by commas. Each key can be optionally appended by a sort direction (:asc or :desc). The valid sort keys are: [‘name’, ‘status’, ‘init_at’, ‘created_at’, ‘updated_at’]

--limit <limit>¶

Limit the number of clusters returned

--marker <id>¶

Only return clusters that appear after the given cluster ID

--global-project¶

Indicate that the cluster list should include clusters from all projects. This option is subject to access policy checking. Default is False

--full-id¶

Print full IDs in list

This command is provided by the python-senlinclient plugin.

cluster members add¶

Add specified nodes to cluster.

openstack cluster members add --nodes <nodes> [--wait] <cluster>

--nodes <nodes>¶

ID or name of nodes to be added; multiple nodes can be separated with “,”

--wait¶

Wait for cluster members add to complete

cluster¶

Name or ID of cluster to operate on

This command is provided by the python-senlinclient plugin.

cluster members del¶

Delete specified nodes from cluster.

openstack cluster members del
    --nodes <nodes>
    [-d DESTROY_AFTER_DELETION]
    [--wait]
    <cluster>

--nodes <nodes>¶

Name or ID of nodes to be deleted; multiple nodes can be separated with “,”

-d <DESTROY_AFTER_DELETION>, --destroy-after-deletion <DESTROY_AFTER_DELETION>¶

Whether nodes should be destroyed after deleted. Default is False.

--wait¶

Wait for cluster members delete to complete

cluster¶

Name or ID of cluster to operate on

This command is provided by the python-senlinclient plugin.

cluster members list¶

List nodes from cluster.

openstack cluster members list
    [--format-config-file FORMAT_CONFIG]
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [--filters <key1=value1;key2=value2...>]
    [--sort <key>[:<direction>]]
    [--limit <limit>]
    [--marker <id>]
    [--full-id]
    <cluster>

--format-config-file <FORMAT_CONFIG>¶

Config file for the dict-to-csv formatter

--sort-column SORT_COLUMN¶

specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

--sort-ascending¶

sort the column(s) in ascending order

--sort-descending¶

sort the column(s) in descending order

--filters <key1=value1;key2=value2...>¶

Filter parameters to apply on returned nodes. This can be specified multiple times, or once with parameters separated by a semicolon. The valid filter keys are: [‘status’, ‘name’]

--sort <key>[:<direction>]¶

Sorting option which is a string containing a list of keys separated by commas. Each key can be optionally appended by a sort direction (:asc or :desc)’ The valid sort keys are:[‘index’, ‘name’, ‘status’, ‘init_at’, ‘created_at’, ‘updated_at’]

--limit <limit>¶

Limit the number of nodes returned

--marker <id>¶

Only return nodes that appear after the given node ID

--full-id¶

Print full IDs in list

cluster¶

Name or ID of cluster to nodes from

This command is provided by the python-senlinclient plugin.

cluster members replace¶

Replace the nodes in a cluster with specified nodes.

openstack cluster members replace
    --nodes <OLD_NODE1
    =NEW_NODE1>
    [--wait]
    <cluster>

--nodes <OLD_NODE1=NEW_NODE1>¶

OLD_NODE is the name or ID of a node to be replaced, NEW_NODE is the name or ID of a node as replacement. This can be specified multiple times, or once with node-pairs separated by a comma ‘,’.

--wait¶

Wait for cluster members replace to complete

cluster¶

Name or ID of cluster to operate on

This command is provided by the python-senlinclient plugin.

cluster node adopt¶

Adopt (or preview) the node.

openstack cluster node adopt
    --identity <identity>
    --type <type>
    [--role <role>]
    [--metadata <"key1=value1;key2=value2...">]
    [--name <node-name>]
    [--overrides <json>]
    [--preview]
    [--snapshot]

--identity <identity>¶

Physical resource id.

--type <type>¶

The name of the profile type.

--role <role>¶

Role for this node in the specific cluster.

--metadata <"key1=value1;key2=value2...">¶

Metadata values to be attached to the node. This can be specified multiple times, or once with key-value pairs separated by a semicolon.

--name <node-name>¶

Name of the node to adopt.

--overrides <json>¶

JSON formatted specification for overriding this node properties.

--preview¶

Whether preview the node adopt request. If set, only previewing this node and do not adopt.

--snapshot¶

Whether a shapshot of the existing physical object should be created before the object is adopted as a node.

This command is provided by the python-senlinclient plugin.

cluster node check¶

Check the node(s).

openstack cluster node check <node> [<node> ...]

node¶

ID or name of node(s) to check.

This command is provided by the python-senlinclient plugin.

cluster node create¶

Create the node.

openstack cluster node create
    [--cluster <cluster>]
    [--role <role>]
    [--metadata <"key1=value1;key2=value2...">]
    --profile <profile>
    <node-name>

--cluster <cluster>¶

Cluster Id or Name for this node

--role <role>¶

Role for this node in the specific cluster

--metadata <"key1=value1;key2=value2...">¶

Metadata values to be attached to the node. This can be specified multiple times, or once with key-value pairs separated by a semicolon

--profile <profile>¶

Profile Id or Name used for this node

node-name¶

Name of the node to create

This command is provided by the python-senlinclient plugin.

cluster node delete¶

Delete the node(s).

openstack cluster node delete
    [--force-delete]
    [--force]
    <node>
    [<node> ...]

--force-delete¶

Force to delete node(s).

--force¶

Skip yes/no prompt (assume yes).

node¶

Name or ID of node(s) to delete.

This command is provided by the python-senlinclient plugin.

cluster node list¶

List nodes.

openstack cluster node list
    [--format-config-file FORMAT_CONFIG]
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [--cluster <cluster>]
    [--filters <"key1=value1;key2=value2...">]
    [--sort <key>[:<direction>]]
    [--limit <limit>]
    [--marker <id>]
    [--global-project]
    [--full-id]

--format-config-file <FORMAT_CONFIG>¶

Config file for the dict-to-csv formatter

--sort-column SORT_COLUMN¶

specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

--sort-ascending¶

sort the column(s) in ascending order

--sort-descending¶

sort the column(s) in descending order

--cluster <cluster>¶

ID or name of cluster from which nodes are to be listed

--filters <"key1=value1;key2=value2...">¶

Filter parameters to apply on returned nodes. This can be specified multiple times, or once with parameters separated by a semicolon. The valid filter keys are: [‘status’,’name’]

--sort <key>[:<direction>]¶

Sorting option which is a string containing a list of keys separated by commas. Each key can be optionally appended by a sort direction (:asc or :desc). The valid sort keys are:[‘index’, ‘name’, ‘status’, ‘init_at’, ‘created_at’, ‘updated_at’]

--limit <limit>¶

Limit the number of nodes returned

--marker <id>¶

Only return nodes that appear after the given node ID

--global-project¶

Indicate that this node list should include nodes from all projects. This option is subject to access policy checking. Default is False

--full-id¶

Print full IDs in list

This command is provided by the python-senlinclient plugin.

cluster node op¶

Perform an operation on a node.

openstack cluster node op
    [--format-config-file FORMAT_CONFIG]
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    --operation <operation>
    [--params <key1=value1;key2=value2...>]
    <node>

--format-config-file <FORMAT_CONFIG>¶

Config file for the dict-to-csv formatter

--sort-column SORT_COLUMN¶

specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

--sort-ascending¶

sort the column(s) in ascending order

--sort-descending¶

sort the column(s) in descending order

--operation <operation>¶

Operation to be performed on the node.

--params <key1=value1;key2=value2...>¶

Parameters to for the specified operation. This can be specified multiple times, or once with parameters separated by a semicolon.

node¶

ID or name the node operate on.

This command is provided by the python-senlinclient plugin.

cluster node recover¶

Recover the node(s).

openstack cluster node recover [--check <boolean>] <node> [<node> ...]

--check <boolean>¶

Whether the node(s) should check physical resource status before doing node recover. Default is false

node¶

ID or name of node(s) to recover.

This command is provided by the python-senlinclient plugin.

cluster node show¶

Show detailed info about the specified node.

openstack cluster node show [--details] <node>

--details¶

Include physical object details

node¶

Name or ID of the node to show the details for

This command is provided by the python-senlinclient plugin.

cluster node update¶

Update the node.

openstack cluster node update
    [--name <name>]
    [--profile <profile>]
    [--role <role>]
    [--metadata <"key1=value1;key2=value2...">]
    [--tainted <boolean>]
    <node>

--name <name>¶

New name for the node

--profile <profile>¶

ID or name of new profile to use

--role <role>¶

Role for this node in the specific cluster

--metadata <"key1=value1;key2=value2...">¶

Metadata values to be attached to the node. This can be specified multiple times, or once with key-value pairs separated by a semicolon. Use ‘{}’ can clean metadata

--tainted <boolean>¶

Whether the node should be marked as tainted. If true, this node will be selected first for the nextcluster scale-in operation.

node¶

Name or ID of node to update

This command is provided by the python-senlinclient plugin.

cluster op¶

Perform an operation on all nodes across a cluster.

openstack cluster op
    --operation <operation>
    [--params <key1=value1;key2=value2...>]
    [--wait]
    <cluster>

--operation <operation>¶

Operation to be performed on the cluster

--params <key1=value1;key2=value2...>¶

Parameters to for the specified operation. This can be specified multiple times, or once with parameters separated by a semicolon.

--wait¶

Wait for cluster operation to complete

cluster¶

ID or name of cluster to operate on.

This command is provided by the python-senlinclient plugin.

cluster policy attach¶

Attach policy to cluster.

openstack cluster policy attach
    [--enabled <boolean>]
    --policy <policy>
    [--wait]
    <cluster>

--enabled <boolean>¶

Whether the policy should be enabled once attached. Default to True

--policy <policy>¶

ID or name of policy to be attached

--wait¶

Wait for cluster policy-attach to complete

cluster¶

Name or ID of cluster to operate on

This command is provided by the python-senlinclient plugin.

cluster policy binding list¶

List policies from cluster.

openstack cluster policy binding list
    [--format-config-file FORMAT_CONFIG]
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [--filters <"key1=value1;key2=value2...">]
    [--sort <key>[:<direction>]]
    [--full-id]
    <cluster>

--format-config-file <FORMAT_CONFIG>¶

Config file for the dict-to-csv formatter

--sort-column SORT_COLUMN¶

specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

--sort-ascending¶

sort the column(s) in ascending order

--sort-descending¶

sort the column(s) in descending order

--filters <"key1=value1;key2=value2...">¶

Filter parameters to apply on returned results. This can be specified multiple times, or once with parameters separated by a semicolon. The valid filter keys are: [‘is_enabled’, ‘policy_type’, ‘policy_name’]

--sort <key>[:<direction>]¶

Sorting option which is a string containing a list of keys separated by commas. Each key can be optionally appended by a sort direction (:asc or :desc). The valid sort keys are: [‘enabled’]

--full-id¶

Print full IDs in list

cluster¶

Name or ID of cluster to query on

This command is provided by the python-senlinclient plugin.

cluster policy binding show¶

Show a specific policy that is bound to the specified cluster.

openstack cluster policy binding show --policy <policy> <cluster>

--policy <policy>¶

ID or name of the policy to query on

cluster¶

ID or name of the cluster to query on

This command is provided by the python-senlinclient plugin.

cluster policy binding update¶

Update a policy’s properties on a cluster.

openstack cluster policy binding update
    --policy <policy>
    --enabled <boolean>
    <cluster>

--policy <policy>¶

ID or name of policy to be updated

--enabled <boolean>¶

Whether the policy should be enabled

cluster¶

Name or ID of cluster to operate on

This command is provided by the python-senlinclient plugin.

cluster policy create¶

Create a policy.

openstack cluster policy create --spec-file <spec-file> <name>

--spec-file <spec-file>¶

The spec file used to create the policy

name¶

Name of the policy to create

This command is provided by the python-senlinclient plugin.

cluster policy delete¶

Delete policy(s).

openstack cluster policy delete [--force] <policy> [<policy> ...]

--force¶

Skip yes/no prompt (assume yes)

policy¶

Name or ID of policy(s) to delete

This command is provided by the python-senlinclient plugin.

cluster policy detach¶

Detach policy from cluster.

openstack cluster policy detach --policy <policy> [--wait] <cluster>

--policy <policy>¶

ID or name of policy to be detached

--wait¶

Wait for cluster policy-detach to complete

cluster¶

Name or ID of cluster to operate on

This command is provided by the python-senlinclient plugin.

cluster policy list¶

List policies that meet the criteria.

openstack cluster policy list
    [--format-config-file FORMAT_CONFIG]
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [--limit <limit>]
    [--marker <id>]
    [--sort <key>[:<direction>]]
    [--filters <"key1=value1;key2=value2...">]
    [--global-project]
    [--full-id]

--format-config-file <FORMAT_CONFIG>¶

Config file for the dict-to-csv formatter

--sort-column SORT_COLUMN¶

specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

--sort-ascending¶

sort the column(s) in ascending order

--sort-descending¶

sort the column(s) in descending order

--limit <limit>¶

Limit the number of policies returned

--marker <id>¶

Only return policies that appear after the given policy ID

--sort <key>[:<direction>]¶

Sorting option which is a string containing a list of keys separated by commas. Each key can be optionally appended by a sort direction (:asc or :desc). The valid sort keys are: [‘type’, ‘name’, ‘created_at’, ‘updated_at’]

--filters <"key1=value1;key2=value2...">¶

Filter parameters to apply on returned policies. This can be specified multiple times, or once with parameters separated by a semicolon. The valid filter keys are: [‘type’, ‘name’]

--global-project¶

Indicate that the list should include policies from all projects. This option is subject to access policy checking. Default is False

--full-id¶

Print full IDs in list

This command is provided by the python-senlinclient plugin.

cluster policy show¶

Show the policy details.

openstack cluster policy show <policy>

policy¶

Name or Id of the policy to show

This command is provided by the python-senlinclient plugin.

cluster policy type list¶

List the available policy types.

openstack cluster policy type list
    [--format-config-file FORMAT_CONFIG]
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]

--format-config-file <FORMAT_CONFIG>¶

Config file for the dict-to-csv formatter

--sort-column SORT_COLUMN¶

specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

--sort-ascending¶

sort the column(s) in ascending order

--sort-descending¶

sort the column(s) in descending order

This command is provided by the python-senlinclient plugin.

cluster policy type show¶

Get the details about a policy type.

openstack cluster policy type show <type-name>

type-name¶

Policy type to retrieve

This command is provided by the python-senlinclient plugin.

cluster policy update¶

Update a policy.

openstack cluster policy update [--name <name>] <policy>

--name <name>¶

New name of the policy to be updated

policy¶

Name or ID of the policy to be updated

This command is provided by the python-senlinclient plugin.

cluster policy validate¶

Validate a policy.

openstack cluster policy validate --spec-file <spec-file>

--spec-file <spec-file>¶

The spec file of the policy to be validated

This command is provided by the python-senlinclient plugin.

cluster profile create¶

Create a profile.

openstack cluster profile create
    [--metadata <"key1=value1;key2=value2...">]
    --spec-file <spec-file>
    <profile-name>

--metadata <"key1=value1;key2=value2...">¶

Metadata values to be attached to the profile. This can be specified multiple times, or once with key-value pairs separated by a semicolon

--spec-file <spec-file>¶

The spec file used to create the profile

profile-name¶

Name of the profile to create

This command is provided by the python-senlinclient plugin.

cluster profile delete¶

Delete profile(s).

openstack cluster profile delete [--force] <profile> [<profile> ...]

--force¶

Skip yes/no prompt (assume yes)

profile¶

Name or ID of profile(s) to delete

This command is provided by the python-senlinclient plugin.

cluster profile list¶

List profiles that meet the criteria.

openstack cluster profile list
    [--format-config-file FORMAT_CONFIG]
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [--limit <limit>]
    [--marker <id>]
    [--sort <key>[:<direction>]]
    [--filters <"key1=value1;key2=value2...">]
    [--global-project]
    [--full-id]

--format-config-file <FORMAT_CONFIG>¶

Config file for the dict-to-csv formatter

--sort-column SORT_COLUMN¶

specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

--sort-ascending¶

sort the column(s) in ascending order

--sort-descending¶

sort the column(s) in descending order

--limit <limit>¶

Limit the number of profiles returned

--marker <id>¶

Only return profiles that appear after the given profile ID

--sort <key>[:<direction>]¶

Sorting option which is a string containing a list of keys separated by commas. Each key can be optionally appended by a sort direction (:asc or :desc). The valid sort_keys are:[‘type’, ‘name’, ‘created_at’, ‘updated_at’]

--filters <"key1=value1;key2=value2...">¶

Filter parameters to apply on returned profiles. This can be specified multiple times, or once with parameters separated by a semicolon. The valid filter keys are: [‘type’, ‘name’]

--global-project¶

Indicate that the list should include profiles from all projects. This option is subject to access policy checking. Default is False

--full-id¶

Print full IDs in list

This command is provided by the python-senlinclient plugin.

cluster profile show¶

Show profile details.

openstack cluster profile show <profile>

profile¶

Name or ID of profile to show

This command is provided by the python-senlinclient plugin.

cluster profile type list¶

List the available profile types.

openstack cluster profile type list
    [--format-config-file FORMAT_CONFIG]
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]

--format-config-file <FORMAT_CONFIG>¶

Config file for the dict-to-csv formatter

--sort-column SORT_COLUMN¶

specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

--sort-ascending¶

sort the column(s) in ascending order

--sort-descending¶

sort the column(s) in descending order

This command is provided by the python-senlinclient plugin.

cluster profile type ops¶

Show the operations about a profile type.

openstack cluster profile type ops <type-name>

type-name¶

Profile type to retrieve

This command is provided by the python-senlinclient plugin.

cluster profile type show¶

Show the details about a profile type.

openstack cluster profile type show <name-version>

name-version¶

Profile type name and version to retrieve (e.g. os.nova.server-1.0)

This command is provided by the python-senlinclient plugin.

cluster profile update¶

Update a profile.

openstack cluster profile update
    [--name <name>]
    [--metadata <"key1=value1;key2=value2...">]
    <profile>

--name <name>¶

The new name for the profile

--metadata <"key1=value1;key2=value2...">¶

Metadata values to be attached to the profile. This can be specified multiple times, or once with key-value pairs separated by a semicolon. Use ‘{}’ can clean metadata

profile¶

Name or ID of the profile to update

This command is provided by the python-senlinclient plugin.

cluster profile validate¶

Validate a profile.

openstack cluster profile validate --spec-file <spec-file>

--spec-file <spec-file>¶

The spec file of the profile to be validated

This command is provided by the python-senlinclient plugin.

cluster receiver create¶

Create a receiver.

openstack cluster receiver create
    [--type <type>]
    [--params <"key1=value1;key2=value2...">]
    [--cluster <cluster>]
    [--action <action>]
    <name>

--type <type>¶

Type of the receiver to create. Receiver type can be “webhook” or “message”. Default to “webhook”.

--params <"key1=value1;key2=value2...">¶

A dictionary of parameters that will be passed to target action when the receiver is triggered

--cluster <cluster>¶

Targeted cluster for this receiver. Required if receiver type is webhook

--action <action>¶

Name or ID of the targeted action to be triggered. Required if receiver type is webhook

name¶

Name of the receiver to create

This command is provided by the python-senlinclient plugin.

cluster receiver delete¶

Delete receiver(s).

openstack cluster receiver delete [--force] <receiver> [<receiver> ...]

--force¶

Skip yes/no prompt (assume yes)

receiver¶

Name or ID of receiver(s) to delete

This command is provided by the python-senlinclient plugin.

cluster receiver list¶

List receivers that meet the criteria.

openstack cluster receiver list
    [--format-config-file FORMAT_CONFIG]
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [--filters <"key1=value1;key2=value2...">]
    [--limit <limit>]
    [--marker <id>]
    [--sort <key>[:<direction>]]
    [--global-project]
    [--full-id]

--format-config-file <FORMAT_CONFIG>¶

Config file for the dict-to-csv formatter

--sort-column SORT_COLUMN¶

specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

--sort-ascending¶

sort the column(s) in ascending order

--sort-descending¶

sort the column(s) in descending order

--filters <"key1=value1;key2=value2...">¶

Filter parameters to apply on returned receivers. This can be specified multiple times, or once with parameters separated by a semicolon. The valid filter keys are: [‘name’, ‘type’, ‘action’, ‘cluster_id’, ‘user_id’]

--limit <limit>¶

Limit the number of receivers returned

--marker <id>¶

Only return receivers that appear after the given receiver ID

--sort <key>[:<direction>]¶

Sorting option which is a string containing a list of keys separated by commas. Each key can be optionally appended by a sort direction (:asc or :desc). The valid sort keys are: [‘name’, ‘type’, ‘action’, ‘cluster_id’, ‘created_at’]

--global-project¶

Indicate that the list should include receivers from all projects. This option is subject to access policy checking. Default is False

--full-id¶

Print full IDs in list

This command is provided by the python-senlinclient plugin.

cluster receiver show¶

Show the receiver details.

openstack cluster receiver show <receiver>

receiver¶

Name or ID of the receiver to show

This command is provided by the python-senlinclient plugin.

cluster receiver update¶

Update a receiver.

openstack cluster receiver update
    [--name <name>]
    [--action <action>]
    [--params <"key1=value1;key2=value2...">]
    <receiver>

--name <name>¶

Name of the receiver to create

--action <action>¶

Name or ID of the targeted action to be triggered. Required if receiver type is webhook

--params <"key1=value1;key2=value2...">¶

A dictionary of parameters that will be passed to target action when the receiver is triggered

receiver¶

Name or ID of receiver(s) to update

This command is provided by the python-senlinclient plugin.

cluster recover¶

Recover the cluster(s).

openstack cluster recover
    [--format-config-file FORMAT_CONFIG]
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [--check <boolean>]
    [--wait]
    <cluster>
    [<cluster> ...]

--format-config-file <FORMAT_CONFIG>¶

Config file for the dict-to-csv formatter

--sort-column SORT_COLUMN¶

specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

--sort-ascending¶

sort the column(s) in ascending order

--sort-descending¶

sort the column(s) in descending order

--check <boolean>¶

Whether the cluster should check it’s nodes status before doing cluster recover. Default is false

--wait¶

Wait for cluster recover to complete

cluster¶

ID or name of cluster(s) to operate on.

This command is provided by the python-senlinclient plugin.

cluster resize¶

Resize a cluster.

openstack cluster resize
    [--capacity <capacity>]
    [--adjustment <adjustment>]
    [--percentage <percentage>]
    [--min-step <min-step>]
    [--strict]
    [--min-size min]
    [--max-size max]
    [--wait]
    <cluster>

--capacity <capacity>¶

The desired number of nodes of the cluster

--adjustment <adjustment>¶

A positive integer meaning the number of nodes to add, or a negative integer indicating the number of nodes to remove

--percentage <percentage>¶

A value that is interpreted as the percentage of size adjustment. This value can be positive or negative

--min-step <min-step>¶

An integer specifying the number of nodes for adjustment when <PERCENTAGE> is specified

--strict¶

A boolean specifying whether the resize should be performed on a best-effort basis when the new capacity may go beyond size constraints

--min-size min¶

New lower bound of cluster size

--max-size max¶

New upper bound of cluster size. A value of -1 indicates no upper limit on cluster size

--wait¶

Wait for cluster resize to complete

cluster¶

Name or ID of cluster to operate on

This command is provided by the python-senlinclient plugin.

cluster run¶

Run scripts on cluster.

openstack cluster run
    [--port <port>]
    [--address-type <address_type>]
    [--network <network>]
    [--ipv6]
    [--user <user>]
    [--identity-file <identity_file>]
    [--ssh-options <ssh_options>]
    --script <script>
    <cluster>

--port <port>¶

The TCP port to use for SSH connection

--address-type <address_type>¶

The type of IP address to use. Possible values include ‘fixed’ and ‘floating’ (the default)

--network <network>¶

The network to use for SSH connection

--ipv6¶

Whether the IPv6 address should be used for SSH. Default to use IPv4 address.

--user <user>¶

The login name to use for SSH connection. Default to ‘root’.

--identity-file <identity_file>¶

The private key file to use, same as the ‘-i’ SSH option

--ssh-options <ssh_options>¶

Extra options to pass to SSH. See: man ssh.

--script <script>¶

Path name of the script file to run

cluster¶

ID or name of cluster(s) to operate on.

This command is provided by the python-senlinclient plugin.

cluster service list¶

Show a list of all running services.

openstack cluster service list
    [--format-config-file FORMAT_CONFIG]
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]

--format-config-file <FORMAT_CONFIG>¶

Config file for the dict-to-csv formatter

--sort-column SORT_COLUMN¶

specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

--sort-ascending¶

sort the column(s) in ascending order

--sort-descending¶

sort the column(s) in descending order

This command is provided by the python-senlinclient plugin.

cluster show¶

Show details of the cluster.

openstack cluster show <cluster>

cluster¶

Name or ID of cluster to show

This command is provided by the python-senlinclient plugin.

cluster shrink¶

Scale in a cluster by the specified number of nodes.

openstack cluster shrink [--count <count>] [--wait] <cluster>

--count <count>¶

Number of nodes to be deleted from the specified cluster

--wait¶

Wait for cluster scale-in to complete

cluster¶

Name or ID of cluster to operate on

This command is provided by the python-senlinclient plugin.

cluster update¶

Update the cluster.

openstack cluster update
    [--config <"key1=value1;key2=value2...">]
    [--profile <profile>]
    [--profile-only <boolean>]
    [--timeout <timeout>]
    [--metadata <"key1=value1;key2=value2...">]
    [--name <name>]
    [--wait]
    <cluster>

--config <"key1=value1;key2=value2...">¶

Configuration of the cluster. This can be specified multiple times, or once with key-value pairs separated by a semicolon. Any existing configuration values on the cluster are wiped out when using this option.

--profile <profile>¶

ID or name of new profile to use

--profile-only <boolean>¶

Whether the cluster should be updated profile only. If false, it will be applied to all existing nodes. If true, any newly created nodes will use the new profile,but existing nodes will not be changed. Default is False.

--timeout <timeout>¶

New timeout (in seconds) value for the cluster

--metadata <"key1=value1;key2=value2...">¶

Metadata values to be attached to the cluster. This can be specified multiple times, or once with key-value pairs separated by a semicolon. Use ‘{}’ can clean metadata

--name <name>¶

New name for the cluster to update

--wait¶

Wait for cluster update to complete

cluster¶

Name or ID of cluster to be updated

This command is provided by the python-senlinclient plugin.