The senlin client is the command-line interface (CLI) for the Clustering service API and its extensions.
This chapter documents senlin version 1.0.0
.
For help on a specific senlin command, enter:
$ senlin help COMMAND
usage: senlin [--version] [-d] [-v] [--api-timeout API_TIMEOUT]
[--senlin-api-version SENLIN_API_VERSION]
[--os-auth-plugin AUTH_PLUGIN] [--os-auth-url AUTH_URL]
[--os-project-id PROJECT_ID] [--os-project-name PROJECT_NAME]
[--os-tenant-id TENANT_ID] [--os-tenant-name TENANT_NAME]
[--os-domain-id DOMAIN_ID] [--os-domain-name DOMAIN_NAME]
[--os-project-domain-id PROJECT_DOMAIN_ID]
[--os-project-domain-name PROJECT_DOMAIN_NAME]
[--os-user-domain-id USER_DOMAIN_ID]
[--os-user-domain-name USER_DOMAIN_NAME]
[--os-username USERNAME] [--os-user-id USER_ID]
[--os-password PASSWORD] [--os-trust-id TRUST_ID]
[--os-cacert CA_BUNDLE_FILE | --verify | --insecure]
[--os-token TOKEN] [--os-access-info ACCESS_INFO]
[--profile HMAC_KEY]
<subcommand> ...
Subcommands:
action-list
action-show
build-info
cluster-check
cluster-collect
cluster-create
cluster-delete
cluster-list
cluster-node-add
cluster-node-del
cluster-node-list
cluster-policy-attach
cluster-policy-detach
cluster-policy-list
cluster-policy-show
cluster-policy-update
cluster-recover
cluster-resize
cluster-run
cluster-scale-in
cluster-scale-out
cluster-show
cluster-update
event-list
event-show
node-check
node-create
node-delete
node-list
node-recover
node-show
node-update
policy-create
policy-delete
policy-list
policy-show
policy-type-list
policy-type-show
policy-update
policy-validate
profile-create
profile-delete
profile-list
profile-show
profile-type-list
profile-type-show
profile-update
profile-validate
receiver-create
receiver-delete
receiver-list
receiver-show
bash-completion
help
--version
-d, --debug
env[SENLINCLIENT_DEBUG]
.-v, --verbose
--api-timeout API_TIMEOUT
--senlin-api-version SENLIN_API_VERSION
--os-auth-plugin AUTH_PLUGIN
env[OS_AUTH_PLUGIN]
--os-auth-url AUTH_URL
env[OS_AUTH_URL]
--os-project-id PROJECT_ID
env[OS_PROJECT_ID]
.--os-project-name PROJECT_NAME
env[OS_PROJECT_NAME]
.--os-tenant-id TENANT_ID
env[OS_TENANT_ID]
.--os-tenant-name TENANT_NAME
env[OS_TENANT_NAME]
.--os-domain-id DOMAIN_ID
env[OS_DOMAIN_ID]
.--os-domain-name DOMAIN_NAME
env[OS_DOMAIN_NAME]
.--os-project-domain-id PROJECT_DOMAIN_ID
env[OS_PROJECT_DOMAIN_ID]
.--os-project-domain-name PROJECT_DOMAIN_NAME
env[OS_PROJECT_DOMAIN_NAME]
.--os-user-domain-id USER_DOMAIN_ID
env[OS_USER_DOMAIN_ID]
.--os-user-domain-name USER_DOMAIN_NAME
env[OS_USER_DOMAIN_NAME]
.--os-username USERNAME
env[OS_USERNAME]
.--os-user-id USER_ID
env[OS_USER_ID]
.--os-password PASSWORD
env[OS_PASSWORD]
--os-trust-id TRUST_ID
env[OS_TRUST_ID]
--os-cacert CA_BUNDLE_FILE
--verify
--insecure
--os-token TOKEN
env[OS_TOKEN]
--os-access-info ACCESS_INFO
env[OS_ACCESS_INFO]
--profile HMAC_KEY
usage: senlin action-list [-f <KEY1=VALUE1;KEY2=VALUE2...>] [-o <KEY:DIR>]
[-l <LIMIT>] [-m <ID>] [-F]
List actions.
Optional arguments:
-f <KEY1=VALUE1;KEY2=VALUE2...>, --filters <KEY1=VALUE1;KEY2=VALUE2...>
-o <KEY:DIR>, --sort <KEY:DIR>
-l <LIMIT>, --limit <LIMIT>
-m <ID>, --marker <ID>
-F, --full-id
usage: senlin action-show <ACTION>
Show detailed info about the specified action.
Positional arguments:
<ACTION>
usage: senlin build-info
Retrieve build information. :param sc: Instance of senlinclient. :param args: Additional command line arguments, if any.
usage: senlin cluster-check <CLUSTER> [<CLUSTER> ...]
Check the cluster(s).
Positional arguments:
<CLUSTER>
usage: senlin cluster-collect [-p <PATH>] [-L] [-F] <CLUSTER>
Collect attributes across a cluster.
Positional arguments:
<CLUSTER>
Optional arguments:
-p <PATH>, --path <PATH>
-L, --list
-F, --full-id
usage: senlin cluster-create -p <PROFILE> [-n <MIN-SIZE>] [-m <MAX-SIZE>]
[-c <DESIRED-CAPACITY>] [-t <TIMEOUT>]
[-M <KEY1=VALUE1;KEY2=VALUE2...>]
<CLUSTER_NAME>
Create the cluster.
Positional arguments:
<CLUSTER_NAME>
Optional arguments:
-p <PROFILE>, --profile <PROFILE>
-n <MIN-SIZE>, --min-size <MIN-SIZE>
-m <MAX-SIZE>, --max-size <MAX-SIZE>
-c <DESIRED-CAPACITY>, --desired-capacity <DESIRED-CAPACITY>
-t <TIMEOUT>, --timeout <TIMEOUT>
-M <KEY1=VALUE1;KEY2=VALUE2...>, --metadata <KEY1=VALUE1;KEY2=VALUE2...>
usage: senlin cluster-delete <CLUSTER> [<CLUSTER> ...]
Delete the cluster(s).
Positional arguments:
<CLUSTER>
usage: senlin cluster-list [-f <KEY1=VALUE1;KEY2=VALUE2...>] [-o <KEY:DIR>]
[-l <LIMIT>] [-m <ID>] [-g] [-F]
List the user’s clusters.
Optional arguments:
-f <KEY1=VALUE1;KEY2=VALUE2...>, --filters <KEY1=VALUE1;KEY2=VALUE2...>
-o <KEY:DIR>, --sort <KEY:DIR>
-l <LIMIT>, --limit <LIMIT>
-m <ID>, --marker <ID>
-g, --global-project
-F, --full-id
usage: senlin cluster-node-add -n <NODES> <CLUSTER>
Add specified nodes to cluster.
Positional arguments:
<CLUSTER>
Optional arguments:
-n <NODES>, --nodes <NODES>
usage: senlin cluster-node-del -n <NODES> <CLUSTER>
Delete specified nodes from cluster.
Positional arguments:
<CLUSTER>
Optional arguments:
-n <NODES>, --nodes <NODES>
usage: senlin cluster-node-list [-f <KEY1=VALUE1;KEY2=VALUE2...>] [-l <LIMIT>]
[-m <ID>] [-F]
<CLUSTER>
List nodes from cluster.
Positional arguments:
<CLUSTER>
Optional arguments:
-f <KEY1=VALUE1;KEY2=VALUE2...>, --filters <KEY1=VALUE1;KEY2=VALUE2...>
-l <LIMIT>, --limit <LIMIT>
-m <ID>, --marker <ID>
-F, --full-id
usage: senlin cluster-policy-attach -p <POLICY> [-e] <NAME or ID>
Attach policy to cluster.
Positional arguments:
<NAME or ID>
Optional arguments:
-p <POLICY>, --policy <POLICY>
-e, --enabled
usage: senlin cluster-policy-detach -p <POLICY> <NAME or ID>
Detach policy from cluster.
Positional arguments:
<NAME or ID>
Optional arguments:
-p <POLICY>, --policy <POLICY>
usage: senlin cluster-policy-list [-f <KEY1=VALUE1;KEY2=VALUE2...>]
[-o <SORT_STRING>] [-F]
<CLUSTER>
List policies from cluster.
Positional arguments:
<CLUSTER>
Optional arguments:
-f <KEY1=VALUE1;KEY2=VALUE2...>, --filters <KEY1=VALUE1;KEY2=VALUE2...>
-o <SORT_STRING>, --sort <SORT_STRING>
-F, --full-id
usage: senlin cluster-policy-show -p <POLICY> <CLUSTER>
Show a specific policy that is bound to the specified cluster.
Positional arguments:
<CLUSTER>
Optional arguments:
-p <POLICY>, --policy <POLICY>
usage: senlin cluster-policy-update -p <POLICY> [-e <BOOLEAN>] <NAME or ID>
Update a policy’s properties on a cluster.
Positional arguments:
<NAME or ID>
Optional arguments:
-p <POLICY>, --policy <POLICY>
-e <BOOLEAN>, --enabled <BOOLEAN>
usage: senlin cluster-recover <CLUSTER> [<CLUSTER> ...]
Recover the cluster(s).
Positional arguments:
<CLUSTER>
usage: senlin cluster-resize [-c <CAPACITY>] [-a <ADJUSTMENT>]
[-p <PERCENTAGE>] [-t <MIN_STEP>] [-s] [-n MIN]
[-m MAX]
<CLUSTER>
Resize a cluster.
Positional arguments:
<CLUSTER>
Optional arguments:
-c <CAPACITY>, --capacity <CAPACITY>
-a <ADJUSTMENT>, --adjustment <ADJUSTMENT>
-p <PERCENTAGE>, --percentage <PERCENTAGE>
-t <MIN_STEP>, --min-step <MIN_STEP>
-s, --strict A
-n MIN, --min-size MIN
-m MAX, --max-size MAX
usage: senlin cluster-run [-p <PORT>] [-t ADDRESS_TYPE] [-n <NETWORK>] [-6]
[-u <USER>] [-i IDENTITY_FILE] [-O SSH_OPTIONS] -s
<FILE>
<CLUSTER>
Run shell scripts on all nodes of a cluster.
Positional arguments:
<CLUSTER>
Optional arguments:
-p <PORT>, --port <PORT>
-t ADDRESS_TYPE, --address-type ADDRESS_TYPE
-n <NETWORK>, --network <NETWORK>
-6, --ipv6
-u <USER>, --user <USER>
-i IDENTITY_FILE, --identity-file IDENTITY_FILE
-O SSH_OPTIONS, --ssh-options SSH_OPTIONS
-s <FILE>, --script <FILE>
usage: senlin cluster-scale-in [-c <COUNT>] <CLUSTER>
Scale in a cluster by the specified number of nodes.
Positional arguments:
<CLUSTER>
Optional arguments:
-c <COUNT>, --count <COUNT>
usage: senlin cluster-scale-out [-c <COUNT>] <CLUSTER>
Scale out a cluster by the specified number of nodes.
Positional arguments:
<CLUSTER>
Optional arguments:
-c <COUNT>, --count <COUNT>
usage: senlin cluster-show <CLUSTER>
Show details of the cluster.
Positional arguments:
<CLUSTER>
usage: senlin cluster-update [-p <PROFILE>] [-t <TIMEOUT>]
[-M <KEY1=VALUE1;KEY2=VALUE2...>] [-n <NAME>]
<CLUSTER>
Update the cluster.
Positional arguments:
<CLUSTER>
Optional arguments:
-p <PROFILE>, --profile <PROFILE>
-t <TIMEOUT>, --timeout <TIMEOUT>
-M <KEY1=VALUE1;KEY2=VALUE2...>, --metadata <KEY1=VALUE1;KEY2=VALUE2...>
-n <NAME>, --name <NAME>
usage: senlin event-list [-f <KEY1=VALUE1;KEY2=VALUE2...>] [-l <LIMIT>]
[-m <ID>] [-o <KEY:DIR>] [-g] [-F]
List events.
Optional arguments:
-f <KEY1=VALUE1;KEY2=VALUE2...>, --filters <KEY1=VALUE1;KEY2=VALUE2...>
-l <LIMIT>, --limit <LIMIT>
-m <ID>, --marker <ID>
-o <KEY:DIR>, --sort <KEY:DIR>
-g, --global-project
-F, --full-id
usage: senlin event-show <EVENT>
Describe the event.
Positional arguments:
<EVENT>
usage: senlin node-check <NODE> [<NODE> ...]
Check the node(s).
Positional arguments:
<NODE>
usage: senlin node-create -p <PROFILE> [-c <CLUSTER>] [-r <ROLE>]
[-M <KEY1=VALUE1;KEY2=VALUE2...>]
<NODE_NAME>
Create the node.
Positional arguments:
<NODE_NAME>
Optional arguments:
-p <PROFILE>, --profile <PROFILE>
-c <CLUSTER>, --cluster <CLUSTER>
-r <ROLE>, --role <ROLE>
-M <KEY1=VALUE1;KEY2=VALUE2...>, --metadata <KEY1=VALUE1;KEY2=VALUE2...>
usage: senlin node-delete <NODE> [<NODE> ...]
Delete the node(s).
Positional arguments:
<NODE>
usage: senlin node-list [-c <CLUSTER>] [-f <KEY1=VALUE1;KEY2=VALUE2...>]
[-o <KEY:DIR>] [-l <LIMIT>] [-m <ID>] [-g] [-F]
Show list of nodes.
Optional arguments:
-c <CLUSTER>, --cluster <CLUSTER>
-f <KEY1=VALUE1;KEY2=VALUE2...>, --filters <KEY1=VALUE1;KEY2=VALUE2...>
-o <KEY:DIR>, --sort <KEY:DIR>
-l <LIMIT>, --limit <LIMIT>
-m <ID>, --marker <ID>
-g, --global-project
-F, --full-id
usage: senlin node-recover <NODE> [<NODE> ...]
Recover the node(s).
Positional arguments:
<NODE>
usage: senlin node-show [-D] <NODE>
Show detailed info about the specified node.
Positional arguments:
<NODE>
Optional arguments:
-D, --details
usage: senlin node-update [-n <NAME>] [-p <PROFILE ID>] [-r <ROLE>]
[-M <KEY1=VALUE1;KEY2=VALUE2...>]
<NODE>
Update the node.
Positional arguments:
<NODE>
Optional arguments:
-n <NAME>, --name <NAME>
-p <PROFILE ID>, --profile <PROFILE ID>
-r <ROLE>, --role <ROLE>
-M <KEY1=VALUE1;KEY2=VALUE2...>, --metadata <KEY1=VALUE1;KEY2=VALUE2...>
usage: senlin policy-create -s <SPEC_FILE> <NAME>
Create a policy.
Positional arguments:
<NAME>
Optional arguments:
-s <SPEC_FILE>, --spec-file <SPEC_FILE>
usage: senlin policy-delete <POLICY> [<POLICY> ...]
Delete policy(s).
Positional arguments:
<POLICY>
usage: senlin policy-list [-f <KEY1=VALUE1;KEY2=VALUE2...>] [-l <LIMIT>]
[-m <ID>] [-o <KEY:DIR>] [-g] [-F]
List policies that meet the criteria.
Optional arguments:
-f <KEY1=VALUE1;KEY2=VALUE2...>, --filters <KEY1=VALUE1;KEY2=VALUE2...>
-l <LIMIT>, --limit <LIMIT>
-m <ID>, --marker <ID>
-o <KEY:DIR>, --sort <KEY:DIR>
-g, --global-project
-F, --full-id
usage: senlin policy-show <POLICY>
Show the policy details.
Positional arguments:
<POLICY>
usage: senlin policy-type-show [-F <FORMAT>] <TYPE_NAME>
Get the details about a policy type.
Positional arguments:
<TYPE_NAME>
Optional arguments:
-F <FORMAT>, --format <FORMAT>
usage: senlin policy-update [-n <NAME>] <POLICY>
Update a policy.
Positional arguments:
<POLICY>
Optional arguments:
-n <NAME>, --name <NAME>
usage: senlin policy-validate -s <SPEC_FILE>
VAlidate a policy spec.
Optional arguments:
-s <SPEC_FILE>, --spec-file <SPEC_FILE>
usage: senlin profile-create -s <SPEC FILE> [-M <KEY1=VALUE1;KEY2=VALUE2...>]
<PROFILE_NAME>
Create a profile.
Positional arguments:
<PROFILE_NAME>
Optional arguments:
-s <SPEC FILE>, --spec-file <SPEC FILE>
-M <KEY1=VALUE1;KEY2=VALUE2...>, --metadata <KEY1=VALUE1;KEY2=VALUE2...>
usage: senlin profile-delete <PROFILE> [<PROFILE> ...]
Delete profile(s).
Positional arguments:
<PROFILE>
usage: senlin profile-list [-f <KEY1=VALUE1;KEY2=VALUE2...>] [-l <LIMIT>]
[-m <ID>] [-o <KEY:DIR>] [-g] [-F]
List profiles that meet the criteria.
Optional arguments:
-f <KEY1=VALUE1;KEY2=VALUE2...>, --filters <KEY1=VALUE1;KEY2=VALUE2...>
-l <LIMIT>, --limit <LIMIT>
-m <ID>, --marker <ID>
-o <KEY:DIR>, --sort <KEY:DIR>
-g, --global-project
-F, --full-id
usage: senlin profile-show <PROFILE>
Show the profile details.
Positional arguments:
<PROFILE>
usage: senlin profile-type-list
List the available profile types. :param sc: Instance of senlinclient. :param args: Additional command line arguments, if any.
usage: senlin profile-type-show [-F <FORMAT>] <TYPE_NAME>
Get the details about a profile type.
Positional arguments:
<TYPE_NAME>
Optional arguments:
-F <FORMAT>, --format <FORMAT>
usage: senlin profile-update [-n <NAME>] [-M <KEY1=VALUE1;KEY2=VALUE2...>]
<PROFILE_ID>
Update a profile.
Positional arguments:
<PROFILE_ID>
Optional arguments:
-n <NAME>, --name <NAME>
-M <KEY1=VALUE1;KEY2=VALUE2...>, --metadata <KEY1=VALUE1;KEY2=VALUE2...>
usage: senlin profile-validate -s <SPEC FILE>
Validate a profile.
Optional arguments:
-s <SPEC FILE>, --spec-file <SPEC FILE>
usage: senlin receiver-create [-t <TYPE>] [-c <CLUSTER>] [-a <ACTION>]
[-P <KEY1=VALUE1;KEY2=VALUE2...>]
<NAME>
Create a receiver.
Positional arguments:
<NAME>
Optional arguments:
-t <TYPE>, --type <TYPE>
-c <CLUSTER>, --cluster <CLUSTER>
-a <ACTION>, --action <ACTION>
-P <KEY1=VALUE1;KEY2=VALUE2...>, --params <KEY1=VALUE1;KEY2=VALUE2...>
usage: senlin receiver-delete <RECEIVER> [<RECEIVER> ...]
Delete receiver(s).
Positional arguments:
<RECEIVER>
usage: senlin receiver-list [-f <KEY1=VALUE1;KEY2=VALUE2...>] [-l <LIMIT>]
[-m <ID>] [-o <KEY:DIR>] [-g] [-F]
List receivers that meet the criteria.
Optional arguments:
-f <KEY1=VALUE1;KEY2=VALUE2...>, --filters <KEY1=VALUE1;KEY2=VALUE2...>
-l <LIMIT>, --limit <LIMIT>
-m <ID>, --marker <ID>
-o <KEY:DIR>, --sort <KEY:DIR>
-g, --global-project
-F, --full-id
usage: senlin receiver-show <RECEIVER>
Show the receiver details.
Positional arguments:
<RECEIVER>
Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.