Clustering service command-line clientThe senlin client is the command-line
interface (CLI) for the Clustering service API and its extensions.
This chapter documents senlin version
0.1.8.
For help on a specific senlin
command, enter:
$senlinCOMMANDsenlin usageusage: 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]
[--os-api-name <service>=<name>]
[--os-api-region <service>=<region>]
[--os-api-version <service>=<version>]
[--os-api-interface <service>=<interface>]
<subcommand> ...Subcommandsaction-list
List actions.
action-show
Show detailed info about the specified action.
build-info
Retrieve build information.
cluster-create
Create the cluster.
cluster-delete
Delete the cluster(s).
cluster-list
List the user's clusters.
cluster-node-add
Add specified nodes to cluster.
cluster-node-del
Delete specified nodes from cluster.
cluster-node-list
List nodes from cluster.
cluster-policy-attach
Attach policy to cluster.
cluster-policy-detach
Detach policy from cluster.
cluster-policy-disable
Disable a policy on a cluster.
cluster-policy-enable
Enable a policy on cluster.
cluster-policy-list
List policies from cluster.
cluster-policy-show
Show a specific policy that is bound to the specified
cluster.
cluster-policy-update
Update a policy on cluster.
cluster-resize
Resize a cluster.
cluster-scale-in
Scale in a cluster by the specified number of nodes.
cluster-scale-out
Scale out a cluster by the specified number of nodes.
cluster-show
Show details of the cluster.
cluster-update
Update the cluster.
event-list
List events.
event-show
Describe the event.
node-create
Create the node.
node-delete
Delete the node(s).
node-join
Make node join the specified cluster.
node-leave
Make node leave its current cluster.
node-list
Show list of nodes.
node-show
Show detailed info about the specified node.
node-update
Update the node.
policy-create
Create a policy.
policy-delete
Delete policy(s).
policy-list
List policies that meet the criteria.
policy-show
Show the policy details.
policy-type-list
List the available policy types.
policy-type-schema
Get the spec of a policy type.
policy-type-show
Show the policy type.
policy-update
Update a policy.
profile-create
Create a profile.
profile-delete
Delete profile(s).
profile-list
List profiles that meet the criteria.
profile-show
Show the profile details.
profile-type-list
List the available profile types.
profile-type-schema
Get the spec of a profile type.
profile-update
Update a profile.
trigger-create
Create a trigger.
trigger-delete
Delete trigger(s).
trigger-list
List triggers that meet the criteria.
trigger-show
Show the trigger details.
webhook-create
Create a webhook.
webhook-delete
Delete webhook(s).
webhook-list
List webhooks that meet the criteria.
webhook-show
Show the webhook details.
bash-completion
Prints all of the commands and options to stdout.
help
Display help about this program or one of its
subcommands.
senlin optional arguments--version
Shows the client version and exits.
-d, --debug
Defaults to env[SENLINCLIENT_DEBUG].
-v, --verbose
Print more verbose output.
--api-timeout API_TIMEOUT
Number of seconds to wait for an API response,
defaults to system socket timeout
--senlin-api-version SENLIN_API_VERSION
Version number for Senlin API to use, Default to "1".
--os-auth-plugin AUTH_PLUGIN
Authentication plugin, default to env[OS_AUTH_PLUGIN]--os-auth-url AUTH_URL
Defaults to env[OS_AUTH_URL]--os-project-id PROJECT_ID
Defaults to env[OS_PROJECT_ID].
--os-project-name PROJECT_NAME
Defaults to env[OS_PROJECT_NAME].
--os-tenant-id TENANT_ID
Defaults to env[OS_TENANT_ID].
--os-tenant-name TENANT_NAME
Defaults to env[OS_TENANT_NAME].
--os-domain-id DOMAIN_ID
Domain ID for scope of authorization, defaults to
env[OS_DOMAIN_ID].
--os-domain-name DOMAIN_NAME
Domain name for scope of authorization, defaults to
env[OS_DOMAIN_NAME].
--os-project-domain-id PROJECT_DOMAIN_ID
Project domain ID for scope of authorization, defaults
to env[OS_PROJECT_DOMAIN_ID].
--os-project-domain-name PROJECT_DOMAIN_NAME
Project domain name for scope of authorization,
defaults to env[OS_PROJECT_DOMAIN_NAME].
--os-user-domain-id USER_DOMAIN_ID
User domain ID for scope of authorization, defaults to
env[OS_USER_DOMAIN_ID].
--os-user-domain-name USER_DOMAIN_NAME
User domain name for scope of authorization, defaults
to env[OS_USER_DOMAIN_NAME].
--os-username USERNAME
Defaults to env[OS_USERNAME].
--os-user-id USER_ID
Defaults to env[OS_USER_ID].
--os-password PASSWORD
Defaults to env[OS_PASSWORD]--os-trust-id TRUST_ID
Defaults to env[OS_TRUST_ID]--os-cacert CA_BUNDLE_FILE
Path of CA TLS certificate(s) used to verify the
remote server's certificate. Without this option
senlin looks for the default system CA certificates.
--verify
Verify server certificate (default)
--insecure
Explicitly allow senlinclient to perform "insecure
SSL" (HTTPS) requests. The server's certificate will
not be verified against any certificate authorities.
This option should be used with caution.
--os-token TOKEN
A string token to bootstrap the Keystone database,
defaults to env[OS_TOKEN]--os-access-info ACCESS_INFO
Access info, defaults to env[OS_ACCESS_INFO]--os-api-name <service>=<name>
Desired API names, defaults to env[OS_API_NAME]--os-api-region <service>=<region>
Desired API region, defaults to env[OS_API_REGION]--os-api-version <service>=<version>
Desired API versions, defaults to env[OS_API_VERSION]--os-api-interface <service>=<interface>
Desired API interface, defaults to env[OS_INTERFACE]senlin action-listusage: senlin action-list [-f <KEY1=VALUE1;KEY2=VALUE2...>] [-k <KEYS>]
[-s <DIR>] [-l <LIMIT>] [-m <ID>] [-D] [-F]
List actions.
Optional arguments-f <KEY1=VALUE1;KEY2=VALUE2...>, --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.
-k <KEYS>, --sort-keys <KEYS>
Name of keys used for sorting the returned events.
-s <DIR>, --sort-dir <DIR>
Direction for sorting, where DIR can be "asc" or
"desc".
-l <LIMIT>, --limit <LIMIT>
Limit the number of nodes returned.
-m <ID>, --marker <ID>
Only return nodes that appear after the given node ID.
-D, --show-deleted
Include soft-deleted nodes if any.
-F, --full-id
Print full IDs in list.
senlin action-showusage: senlin action-show <ACTION>
Show detailed info about the specified action.
Positional arguments<ACTION>
Name or ID of the action to show the details for.
senlin build-infousage: senlin build-info
Retrieve build information. :param sc: Instance of senlinclient. :param args:
Additional command line arguments, if any.
senlin cluster-createusage: senlin cluster-create -p <PROFILE> [-n <MIN-SIZE>] [-m <MAX-SIZE>]
[-c <DESIRED-CAPACITY>] [-o <PARENT_ID>]
[-t <TIMEOUT>] [-M <KEY1=VALUE1;KEY2=VALUE2...>]
<CLUSTER_NAME>
Create the cluster.
Positional arguments<CLUSTER_NAME>
Name of the cluster to create.
Optional arguments-p <PROFILE>, --profile <PROFILE>
Profile Id used for this cluster.
-n <MIN-SIZE>, --min-size <MIN-SIZE>
Min size of the cluster. Default to 0.
-m <MAX-SIZE>, --max-size <MAX-SIZE>
Max size of the cluster. Default to -1, means
unlimited.
-c <DESIRED-CAPACITY>, --desired-capacity <DESIRED-CAPACITY>
Desired capacity of the cluster. Default to 0.
-o <PARENT_ID>, --parent <PARENT_ID>
ID of the parent cluster, if exists.
-t <TIMEOUT>, --timeout <TIMEOUT>
Cluster creation timeout in minutes.
-M <KEY1=VALUE1;KEY2=VALUE2...>, --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.
senlin cluster-deleteusage: senlin cluster-delete <CLUSTER> [<CLUSTER> ...]
Delete the cluster(s).
Positional arguments<CLUSTER>
Name or ID of cluster(s) to delete.
senlin cluster-listusage: senlin cluster-list [-D] [-n] [-f <KEY1=VALUE1;KEY2=VALUE2...>]
[-k <KEYS>] [-s <DIR>] [-l <LIMIT>] [-m <ID>] [-g]
[-F]
List the user's clusters.
Optional arguments-D, --show-deleted
Include soft-deleted clusters if any.
-n, --show-nested
Include nested clusters if any.
-f <KEY1=VALUE1;KEY2=VALUE2...>, --filters <KEY1=VALUE1;KEY2=VALUE2...>
Filter parameters to apply on returned triggers. This
can be specified multiple times, or once with
parameters separated by a semicolon.
-k <KEYS>, --sort-keys <KEYS>
Name of keys used for sorting the returned events.
-s <DIR>, --sort-dir <DIR>
Direction for sorting, where DIR can be "asc" or
"desc".
-l <LIMIT>, --limit <LIMIT>
Limit the number of clusters returned.
-m <ID>, --marker <ID>
Only return clusters that appear after the given
cluster ID.
-g, --global-project
Indicate that the cluster list should include clusters
from all projects. This option is subject to access
policy checking. Default is False.
-F, --full-id
Print full IDs in list.
senlin cluster-node-addusage: senlin cluster-node-add -n <NODES> <CLUSTER>
Add specified nodes to cluster.
Positional arguments<CLUSTER>
Name or ID of cluster to operate on.
Optional arguments-n <NODES>, --nodes <NODES>
ID of nodes to be added; multiple nodes can be
separated with ","
senlin cluster-node-delusage: senlin cluster-node-del -n <NODES> <CLUSTER>
Delete specified nodes from cluster.
Positional arguments<CLUSTER>
Name or ID of cluster to operate on.
Optional arguments-n <NODES>, --nodes <NODES>
ID of nodes to be deleted; multiple nodes can be
separatedwith ",".
senlin cluster-node-listusage: senlin cluster-node-list [-D] [-f <KEY1=VALUE1;KEY2=VALUE2...>]
[-l <LIMIT>] [-m <ID>] [-F]
<CLUSTER>
List nodes from cluster.
Positional arguments<CLUSTER>
Name or ID of cluster to nodes from.
Optional arguments-D, --show-deleted
Include soft-deleted nodes if any.
-f <KEY1=VALUE1;KEY2=VALUE2...>, --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.
-l <LIMIT>, --limit <LIMIT>
Limit the number of nodes returned.
-m <ID>, --marker <ID>
Only return nodes that appear after the given node ID.
-F, --full-id
Print full IDs in list.
senlin cluster-policy-attachusage: senlin cluster-policy-attach -p <POLICY> [-r <PRIORITY>] [-l <LEVEL>]
[-c <SECONDS>] [-e]
<NAME or ID>
Attach policy to cluster.
Positional arguments<NAME or ID>
Name or ID of cluster to operate on.
Optional arguments-p <POLICY>, --policy <POLICY>
ID or name of policy to be attached.
-r <PRIORITY>, --priority <PRIORITY>
An integer specifying the relative priority among all
policies attached to a cluster. The lower the value,
the higher the priority. Default is 50.
-l <LEVEL>, --enforcement-level <LEVEL>
An integer between 0 and 100 representing the
enforcement level. Default to enforcement level of
policy.
-c <SECONDS>, --cooldown <SECONDS>
An integer indicating the cooldown seconds once the
policy is effected. Default to cooldown of policy.
-e, --enabled
Whether the policy should be enabled once attached.
Default to enabled.
senlin cluster-policy-detachusage: senlin cluster-policy-detach -p <POLICY> <NAME or ID>
Detach policy from cluster.
Positional arguments<NAME or ID>
Name or ID of cluster to operate on.
Optional arguments-p <POLICY>, --policy <POLICY>
ID or name of policy to be detached.
senlin cluster-policy-disableusage: senlin cluster-policy-disable -p <POLICY> <NAME or ID>
Disable a policy on a cluster.
Positional arguments<NAME or ID>
Name or ID of cluster to operate on.
Optional arguments-p <POLICY>, --policy <POLICY>
ID or name of policy to be disabled.
senlin cluster-policy-enableusage: senlin cluster-policy-enable -p <POLICY> <NAME or ID>
Enable a policy on cluster.
Positional arguments<NAME or ID>
Name or ID of cluster to operate on.
Optional arguments-p <POLICY>, --policy <POLICY>
ID or name of policy to be enabled.
senlin cluster-policy-listusage: senlin cluster-policy-list [-f <KEY1=VALUE1;KEY2=VALUE2...>]
[-k <KEYS>] [-s <DIR>]
<CLUSTER>
List policies from cluster.
Positional arguments<CLUSTER>
Name or ID of cluster to query on.
Optional arguments-f <KEY1=VALUE1;KEY2=VALUE2...>, --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.
-k <KEYS>, --sort-keys <KEYS>
Name of keys used for sorting the returned events.
-s <DIR>, --sort-dir <DIR>
Direction for sorting, where DIR can be "asc" or
"desc".
senlin cluster-policy-showusage: senlin cluster-policy-show -p <POLICY> <CLUSTER>
Show a specific policy that is bound to the specified cluster.
Positional arguments<CLUSTER>
ID or name of the cluster to query on.
Optional arguments-p <POLICY>, --policy <POLICY>
ID or name of the policy to query on.
senlin cluster-policy-updateusage: senlin cluster-policy-update -p <POLICY> [-r <PRIORITY>] [-l <LEVEL>]
[-c <COOLDOWN>] [-e <BOOLEAN>]
<NAME or ID>
Update a policy on cluster.
Positional arguments<NAME or ID>
Name or ID of cluster to operate on.
Optional arguments-p <POLICY>, --policy <POLICY>
ID or name of policy to be updated.
-r <PRIORITY>, --priority <PRIORITY>
An integer specifying the relative priority among all
policies attached to a cluster. The lower the value,
the higher the priority. Default is 50.
-l <LEVEL>, --enforcement-level <LEVEL>
New enforcement level.
-c <COOLDOWN>, --cooldown <COOLDOWN>
Cooldown interval in seconds.
-e <BOOLEAN>, --enabled <BOOLEAN>
Whether the policy should be enabled.
senlin cluster-resizeusage: senlin cluster-resize [-c <CAPACITY>] [-a <ADJUSTMENT>]
[-p <PERCENTAGE>] [-t <MIN_STEP>] [-s] [-n MIN]
[-m MAX]
<CLUSTER>
Resize a cluster.
Positional arguments<CLUSTER>
Name or ID of cluster to operate on.
Optional arguments-c <CAPACITY>, --capacity <CAPACITY>
The desired number of nodes of the cluster.
-a <ADJUSTMENT>, --adjustment <ADJUSTMENT>
A positive integer meaning the number of nodes to add,
or a negative integer indicating the number of nodes
to remove.
-p <PERCENTAGE>, --percentage <PERCENTAGE>
A value that is interpreted as the percentage of size
adjustment. This value can be positive or negative.
-t <MIN_STEP>, --min-step <MIN_STEP>
An integer specifying the number of nodes for
adjustment when <PERCENTAGE> is specified.
-s, --strict A
boolean specifying whether the resize should be
performed on a best-effort basis when the new capacity
may go beyond size constraints.
-n MIN, --min-size MIN
New lower bound of cluster size.
-m MAX, --max-size MAX
New upper bound of cluster size. A value of -1
indicates no upper limit on cluster size.
senlin cluster-scale-inusage: senlin cluster-scale-in [-c <COUNT>] <CLUSTER>
Scale in a cluster by the specified number of nodes.
Positional arguments<CLUSTER>
Name or ID of cluster to operate on.
Optional arguments-c <COUNT>, --count <COUNT>
Number of nodes to be deleted from the specified
cluster.
senlin cluster-scale-outusage: senlin cluster-scale-out [-c <COUNT>] <CLUSTER>
Scale out a cluster by the specified number of nodes.
Positional arguments<CLUSTER>
Name or ID of cluster to operate on.
Optional arguments-c <COUNT>, --count <COUNT>
Number of nodes to be added to the specified cluster.
senlin cluster-showusage: senlin cluster-show <CLUSTER>
Show details of the cluster.
Positional arguments<CLUSTER>
Name or ID of cluster to show.
senlin cluster-updateusage: senlin cluster-update [-p <PROFILE>] [-t <TIMEOUT>] [-r <PARENT>]
[-M <KEY1=VALUE1;KEY2=VALUE2...>] [-n <NAME>]
<CLUSTER>
Update the cluster.
Positional arguments<CLUSTER>
Name or ID of cluster to be updated.
Optional arguments-p <PROFILE>, --profile <PROFILE>
ID of new profile to use.
-t <TIMEOUT>, --timeout <TIMEOUT>
New timeout (in minutes) value for the cluster.
-r <PARENT>, --parent <PARENT>
ID of parent cluster for the cluster.
-M <KEY1=VALUE1;KEY2=VALUE2...>, --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.
-n <NAME>, --name <NAME>
New name for the cluster to update.
senlin event-listusage: senlin event-list [-f <KEY1=VALUE1;KEY2=VALUE2...>] [-l <LIMIT>]
[-m <ID>] [-k <KEYS>] [-s <DIR>] [-g] [-D] [-F]
List events.
Optional arguments-f <KEY1=VALUE1;KEY2=VALUE2...>, --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.
-l <LIMIT>, --limit <LIMIT>
Limit the number of events returned.
-m <ID>, --marker <ID>
Only return events that appear after the given event
ID.
-k <KEYS>, --sort-keys <KEYS>
Name of keys used for sorting the returned events.
-s <DIR>, --sort-dir <DIR>
Direction for sorting, where DIR can be "asc" or
"desc".
-g, --global-project
Whether events from all projects should be listed.
Default to False. Setting this to True may demand for
an admin privilege.
-D, --show-deleted
Whether deleted events should be listed as well.
Default to False.
-F, --full-id
Print full IDs in list.
senlin event-showusage: senlin event-show <EVENT>
Describe the event.
Positional arguments<EVENT>
ID of event to display details for.
senlin node-createusage: senlin node-create -p <PROFILE> [-c <CLUSTER>] [-r <ROLE>]
[-M <KEY1=VALUE1;KEY2=VALUE2...>]
<NODE_NAME>
Create the node.
Positional arguments<NODE_NAME>
Name of the node to create.
Optional arguments-p <PROFILE>, --profile <PROFILE>
Profile Id used for this node.
-c <CLUSTER>, --cluster <CLUSTER>
Cluster Id for this node.
-r <ROLE>, --role <ROLE>
Role for this node in the specific cluster.
-M <KEY1=VALUE1;KEY2=VALUE2...>, --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.
senlin node-deleteusage: senlin node-delete <NODE> [<NODE> ...]
Delete the node(s).
Positional arguments<NODE>
Name or ID of node(s) to delete.
senlin node-joinusage: senlin node-join -c CLUSTER <NODE>
Make node join the specified cluster.
Positional arguments<NODE>
Name or ID of node to operate on.
Optional arguments-c CLUSTER, --cluster CLUSTER
ID or name of cluster for node to join.
senlin node-leaveusage: senlin node-leave <NODE>
Make node leave its current cluster.
Positional arguments<NODE>
Name or ID of node to operate on.
senlin node-listusage: senlin node-list [-c <CLUSTER>] [-D] [-f <KEY1=VALUE1;KEY2=VALUE2...>]
[-k <KEYS>] [-s <DIR>] [-l <LIMIT>] [-m <ID>] [-g]
[-F]
Show list of nodes.
Optional arguments-c <CLUSTER>, --cluster <CLUSTER>
ID or name of cluster from which nodes are to be
listed.
-D, --show-deleted
Include soft-deleted nodes if any.
-f <KEY1=VALUE1;KEY2=VALUE2...>, --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.
-k <KEYS>, --sort-keys <KEYS>
Name of keys used for sorting the returned nodes.
-s <DIR>, --sort-dir <DIR>
Direction for sorting, where DIR can be "asc" or
"desc".
-l <LIMIT>, --limit <LIMIT>
Limit the number of nodes returned.
-m <ID>, --marker <ID>
Only return nodes that appear after the given node ID.
-g, --global-project
Indicate that this node list should include nodes from
all projects. This option is subject to access policy
checking. Default is False.
-F, --full-id
Print full IDs in list.
senlin node-showusage: senlin node-show [-D] <NODE>
Show detailed info about the specified node.
Positional arguments<NODE>
Name or ID of the node to show the details for.
Optional arguments-D, --details
Include physical object details.
senlin node-updateusage: senlin node-update [-n <NAME>] [-p <PROFILE ID>] [-r <ROLE>]
[-M <KEY1=VALUE1;KEY2=VALUE2...>]
<NODE>
Update the node.
Positional arguments<NODE>
Name or ID of node to update.
Optional arguments-n <NAME>, --name <NAME>
New name for the node.
-p <PROFILE ID>, --profile <PROFILE ID>
ID of new profile to use.
-r <ROLE>, --role <ROLE>
Role for this node in the specific cluster.
-M <KEY1=VALUE1;KEY2=VALUE2...>, --metadata <KEY1=VALUE1;KEY2=VALUE2...>
Metadata values to be attached to the node. Metadata
can be specified multiple times, or once with key-
value pairs separated by a semicolon.
senlin policy-createusage: senlin policy-create -s <SPEC_FILE> [-c <SECONDS>] [-l <LEVEL>] <NAME>
Create a policy.
Positional arguments<NAME>
Name of the policy to create.
Optional arguments-s <SPEC_FILE>, --spec-file <SPEC_FILE>
The spec file used to create the policy.
-c <SECONDS>, --cooldown <SECONDS>
An integer indicating the cooldown seconds once the
policy is effected. Default to 0.
-l <LEVEL>, --enforcement-level <LEVEL>
An integer between 0 and 100 representing the
enforcement level. Default to 0.
senlin policy-deleteusage: senlin policy-delete <POLICY> [<POLICY> ...]
Delete policy(s).
Positional arguments<POLICY>
Name or ID of policy(s) to delete.
senlin policy-listusage: senlin policy-list [-D] [-l <LIMIT>] [-m <ID>] [-F]
List policies that meet the criteria.
Optional arguments-D, --show-deleted
Include soft-deleted policies if any.
-l <LIMIT>, --limit <LIMIT>
Limit the number of policies returned.
-m <ID>, --marker <ID>
Only return policies that appear after the given ID.
-F, --full-id
Print full IDs in list.
senlin policy-showusage: senlin policy-show <POLICY>
Show the policy details.
Positional arguments<POLICY>
Name of the policy to be updated.
senlin policy-type-listusage: senlin policy-type-list
List the available policy types.
senlin policy-type-schemausage: senlin policy-type-schema [-F <FORMAT>] <POLICY_TYPE>
Get the spec of a policy type.
Positional arguments<POLICY_TYPE>
Policy type to generate a template for.
Optional arguments-F <FORMAT>, --format <FORMAT>
The template output format, one of: yaml, json.
senlin policy-type-showusage: senlin policy-type-show <POLICY_TYPE>
Show the policy type.
Positional arguments<POLICY_TYPE>
Policy type to get the details for.
senlin policy-updateusage: senlin policy-update [-c <SECONDS>] [-l <LEVEL>] [-n <NAME>] <POLICY>
Update a policy.
Positional arguments<POLICY>
Name of the policy to be updated.
Optional arguments-c <SECONDS>, --cooldown <SECONDS>
An integer indicating the cooldown seconds once the
policy is effected. Default to 0.
-l <LEVEL>, --enforcement-level <LEVEL>
An integer between 0 and 100 representing the
enforcement level. Default to 0.
-n <NAME>, --name <NAME>
New name of the policy to be updated.
senlin profile-createusage: senlin profile-create -s <SPEC FILE> [-p <PERMISSION>]
[-M <KEY1=VALUE1;KEY2=VALUE2...>]
<PROFILE_NAME>
Create a profile.
Positional arguments<PROFILE_NAME>
Name of the profile to create.
Optional arguments-s <SPEC FILE>, --spec-file <SPEC FILE>
The spec file used to create the profile.
-p <PERMISSION>, --permission <PERMISSION>
A string format permission for this profile.
-M <KEY1=VALUE1;KEY2=VALUE2...>, --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.
senlin profile-deleteusage: senlin profile-delete <PROFILE> [<PROFILE> ...]
Delete profile(s).
Positional arguments<PROFILE>
Name or ID of profile(s) to delete.
senlin profile-listusage: senlin profile-list [-D] [-l <LIMIT>] [-m <ID>] [-F]
List profiles that meet the criteria.
Optional arguments-D, --show-deleted
Include soft-deleted profiles if any.
-l <LIMIT>, --limit <LIMIT>
Limit the number of profiles returned.
-m <ID>, --marker <ID>
Only return profiles that appear after the given ID.
-F, --full-id
Print full IDs in list.
senlin profile-showusage: senlin profile-show <PROFILE>
Show the profile details.
Positional arguments<PROFILE>
Name or ID of profile to show.
senlin profile-type-listusage: senlin profile-type-list
List the available profile types. :param sc: Instance of senlinclient. :param
args: Additional command line arguments, if any.
senlin profile-type-schemausage: senlin profile-type-schema [-F <FORMAT>] <PROFILE_TYPE>
Get the spec of a profile type.
Positional arguments<PROFILE_TYPE>
Profile type to generate a template for.
Optional arguments-F <FORMAT>, --format <FORMAT>
The template output format, one of: yaml, json.
senlin profile-updateusage: senlin profile-update [-n <NAME>] [-p <PERMISSION>]
[-M <KEY1=VALUE1;KEY2=VALUE2...>]
<PROFILE_ID>
Update a profile.
Positional arguments<PROFILE_ID>
Name or ID of the profile to update.
Optional arguments-n <NAME>, --name <NAME>
The new name for the profile.
-p <PERMISSION>, --permission <PERMISSION>
A string format permission for this profile.
-M <KEY1=VALUE1;KEY2=VALUE2...>, --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.
senlin trigger-createusage: senlin trigger-create -s <SPEC FILE> [--desc <DESCRIPTION>] [-e]
[-v SEVERITY] [--state STATE]
<TRIGGER_NAME>
Create a trigger.
Positional arguments<TRIGGER_NAME>
Name of the trigger to create.
Optional arguments-s <SPEC FILE>, --spec-file <SPEC FILE>
The spec file used to create the trigger.
--desc <DESCRIPTION>
A string for describing of the trigger to be created.
-e, --enabled
Whether the trigger should be enabled when created.
-v SEVERITY, --severity SEVERITY
Severity level of the target trigger to be created.
--state STATE
Initial state of the target trigger.
senlin trigger-deleteusage: senlin trigger-delete <TRIGGER> [<TRIGGER> ...]
Delete trigger(s).
Positional arguments<TRIGGER>
Name or ID of trigger(s) to delete.
senlin trigger-listusage: senlin trigger-list [-D] [-l <LIMIT>] [-m <ID>] [-k <KEYS>] [-s <DIR>]
[-f <KEY1=VALUE1;KEY2=VALUE2...>] [-g] [-F]
List triggers that meet the criteria.
Optional arguments-D, --show-deleted
Include soft-deleted triggers if any.
-l <LIMIT>, --limit <LIMIT>
Limit the number of triggers returned.
-m <ID>, --marker <ID>
Only return triggers that appear after the given ID.
-k <KEYS>, --sort-keys <KEYS>
Name of keys used for sorting the returned triggers.
-s <DIR>, --sort-dir <DIR>
Direction for sorting, where DIR can be "asc" or
"desc".
-f <KEY1=VALUE1;KEY2=VALUE2...>, --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.
-g, --global-project
Indicate that the list should include triggers from
all projects. This option is subject to access policy
checking. Default is False.
-F, --full-id
Print full IDs in list.
senlin trigger-showusage: senlin trigger-show <TRIGGER>
Show the trigger details.
Positional arguments<TRIGGER>
Name or ID of trigger to show.
senlin webhook-createusage: senlin webhook-create [-c <CLUSTER>] [-n <NODE>] -a <ACTION>
[-C <KEY1=VALUE1;KEY2=VALUE2...>]
[-P <KEY1=VALUE1;KEY2=VALUE2...>]
<NAME>
Create a webhook.
Positional arguments<NAME>
Name of the webhook to create.
Optional arguments-c <CLUSTER>, --cluster <CLUSTER>
Targeted cluster for this webhook.
-n <NODE>, --node <NODE>
Targeted node for this webhook.
-a <ACTION>, --action <ACTION>
Name of action to be triggered for this webhook.
-C <KEY1=VALUE1;KEY2=VALUE2...>, --credential <KEY1=VALUE1;KEY2=VALUE2...>
The credential to be used when the webhook is
triggered.
-P <KEY1=VALUE1;KEY2=VALUE2...>, --params <KEY1=VALUE1;KEY2=VALUE2...>
A dictionary of parameters that will be passed to
target action when the webhook is triggered.
senlin webhook-deleteusage: senlin webhook-delete <WEBHOOK> [<WEBHOOK> ...]
Delete webhook(s).
Positional arguments<WEBHOOK>
Name or ID of webhook(s) to delete.
senlin webhook-listusage: senlin webhook-list [-D] [-l <LIMIT>] [-m <ID>] [-F]
List webhooks that meet the criteria.
Optional arguments-D, --show-deleted
Include deleted webhooks if any.
-l <LIMIT>, --limit <LIMIT>
Limit the number of webhooks returned.
-m <ID>, --marker <ID>
Only return webhooks that appear after the given ID.
-F, --full-id
Print full IDs in list.
senlin webhook-showusage: senlin webhook-show <WEBHOOK>
Show the webhook details.
Positional arguments<WEBHOOK>
Name or ID of the webhook to show.