Chapter 71. service
This chapter describes the commands under the service
command.
71.1. service create
Create new service
Usage:
openstack service create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--name <name>] [--description <description>] [--enable | --disable] <type>
Table 71.1. Positional arguments
Value | Summary |
---|---|
<type> | New service type (compute, image, identity, volume, etc) |
Table 71.2. Command arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
--name <name> | New service name |
--description <description> | New service description |
--enable | Enable service (default) |
--disable | Disable service |
Table 71.3. Output formatter options
Value | Summary |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
Table 71.4. JSON formatter options
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 71.5. Shell formatter options
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
Table 71.6. Table formatter options
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable |
--print-empty | Print empty table if there is no data to show. |
71.2. service delete
Delete service(s)
Usage:
openstack service delete [-h] <service> [<service> ...]
Table 71.7. Positional arguments
Value | Summary |
---|---|
<service> | Service(s) to delete (type, name or id) |
Table 71.8. Command arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
71.3. service list
List services
Usage:
openstack service list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--long]
Table 71.9. Command arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
--long | List additional fields in output |
Table 71.10. Output formatter options
Value | Summary |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
--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 |
Table 71.11. CSV formatter options
Value | Summary |
---|---|
--quote {all,minimal,none,nonnumeric} | When to include quotes, defaults to nonnumeric |
Table 71.12. JSON formatter options
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 71.13. Table formatter options
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable |
--print-empty | Print empty table if there is no data to show. |
71.4. service provider create
Create new service provider
Usage:
openstack service provider create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] --auth-url <auth-url> [--description <description>] --service-provider-url <sp-url> [--enable | --disable] <name>
Table 71.14. Positional arguments
Value | Summary |
---|---|
<name> | New service provider name (must be unique) |
Table 71.15. Command arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
--auth-url <auth-url> | Authentication url of remote federated service provider (required) |
--description <description> | New service provider description |
--service-provider-url <sp-url> | A service url where saml assertions are being sent (required) |
--enable | Enable the service provider (default) |
--disable | Disable the service provider |
Table 71.16. Output formatter options
Value | Summary |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
Table 71.17. JSON formatter options
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 71.18. Shell formatter options
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
Table 71.19. Table formatter options
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable |
--print-empty | Print empty table if there is no data to show. |
71.5. service provider delete
Delete service provider(s)
Usage:
openstack service provider delete [-h] <service-provider> [<service-provider> ...]
Table 71.20. Positional arguments
Value | Summary |
---|---|
<service-provider> | Service provider(s) to delete |
Table 71.21. Command arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
71.6. service provider list
List service providers
Usage:
openstack service provider list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN]
Table 71.22. Command arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
Table 71.23. Output formatter options
Value | Summary |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
--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 |
Table 71.24. CSV formatter options
Value | Summary |
---|---|
--quote {all,minimal,none,nonnumeric} | When to include quotes, defaults to nonnumeric |
Table 71.25. JSON formatter options
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 71.26. Table formatter options
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable |
--print-empty | Print empty table if there is no data to show. |
71.7. service provider set
Set service provider properties
Usage:
openstack service provider set [-h] [--auth-url <auth-url>] [--description <description>] [--service-provider-url <sp-url>] [--enable | --disable] <service-provider>
Table 71.27. Positional arguments
Value | Summary |
---|---|
<service-provider> | Service provider to modify |
Table 71.28. Command arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
--auth-url <auth-url> | New authentication url of remote federated service provider |
--description <description> | New service provider description |
--service-provider-url <sp-url> | New service provider url, where saml assertions are sent |
--enable | Enable the service provider |
--disable | Disable the service provider |
71.8. service provider show
Display service provider details
Usage:
openstack service provider show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <service-provider>
Table 71.29. Positional arguments
Value | Summary |
---|---|
<service-provider> | Service provider to display |
Table 71.30. Command arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
Table 71.31. Output formatter options
Value | Summary |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
Table 71.32. JSON formatter options
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 71.33. Shell formatter options
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
Table 71.34. Table formatter options
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable |
--print-empty | Print empty table if there is no data to show. |
71.9. service set
Set service properties
Usage:
openstack service set [-h] [--type <type>] [--name <service-name>] [--description <description>] [--enable | --disable] <service>
Table 71.35. Positional arguments
Value | Summary |
---|---|
<service> | Service to modify (type, name or id) |
Table 71.36. Command arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
--type <type> | New service type (compute, image, identity, volume, etc) |
--name <service-name> | New service name |
--description <description> | New service description |
--enable | Enable service |
--disable | Disable service |
71.10. service show
Display service details
Usage:
openstack service show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <service>
Table 71.37. Positional arguments
Value | Summary |
---|---|
<service> | Service to display (type, name or id) |
Table 71.38. Command arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
Table 71.39. Output formatter options
Value | Summary |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
Table 71.40. JSON formatter options
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 71.41. Shell formatter options
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
Table 71.42. Table formatter options
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable |
--print-empty | Print empty table if there is no data to show. |