Chapter 73. service

73.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 73.1. Positional Arguments
Value	Summary
<type>	New service type (compute, image, identity, volume, etc)

Table 73.2. Optional 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 73.3. Output Formatters
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 73.4. JSON Formatter
Value	Summary
--noindent	Whether to disable indenting the json

Table 73.5. Shell Formatter
Value	Summary
--prefix PREFIX	Add a prefix to all variable names

Table 73.6. Table Formatter
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.

73.2. service delete

Delete service(s)

Usage:

openstack service delete [-h] <service> [<service> ...]

Table 73.7. Positional Arguments
Value	Summary
<service>	Service(s) to delete (type, name or id)

Table 73.8. Optional Arguments
Value	Summary
-h, --help	Show this help message and exit

73.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 73.9. Optional Arguments
Value	Summary
-h, --help	Show this help message and exit
--long	List additional fields in output

Table 73.10. Output Formatters
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 73.11. CSV Formatter
Value	Summary
--quote {all,minimal,none,nonnumeric}	When to include quotes, defaults to nonnumeric

Table 73.12. JSON Formatter
Value	Summary
--noindent	Whether to disable indenting the json

Table 73.13. Table Formatter
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.

73.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 73.14. Positional Arguments
Value	Summary
<name>	New service provider name (must be unique)

Table 73.15. Optional 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 73.16. Output Formatters
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 73.17. JSON Formatter
Value	Summary
--noindent	Whether to disable indenting the json

Table 73.18. Shell Formatter
Value	Summary
--prefix PREFIX	Add a prefix to all variable names

Table 73.19. Table Formatter
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.

73.5. service provider delete

Delete service provider(s)

Usage:

openstack service provider delete [-h]
                                         <service-provider>
                                         [<service-provider> ...]

Table 73.20. Positional Arguments
Value	Summary
<service-provider>	Service provider(s) to delete

Table 73.21. Optional Arguments
Value	Summary
-h, --help	Show this help message and exit

73.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 73.22. Optional Arguments
Value	Summary
-h, --help	Show this help message and exit

Table 73.23. Output Formatters
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 73.24. CSV Formatter
Value	Summary
--quote {all,minimal,none,nonnumeric}	When to include quotes, defaults to nonnumeric

Table 73.25. JSON Formatter
Value	Summary
--noindent	Whether to disable indenting the json

Table 73.26. Table Formatter
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.

73.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 73.27. Positional Arguments
Value	Summary
<service-provider>	Service provider to modify

Table 73.28. Optional 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

73.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 73.29. Positional Arguments
Value	Summary
<service-provider>	Service provider to display

Table 73.30. Optional Arguments
Value	Summary
-h, --help	Show this help message and exit

Table 73.31. Output Formatters
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 73.32. JSON Formatter
Value	Summary
--noindent	Whether to disable indenting the json

Table 73.33. Shell Formatter
Value	Summary
--prefix PREFIX	Add a prefix to all variable names

Table 73.34. Table Formatter
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.

73.9. service set

Set service properties

Usage:

openstack service set [-h] [--type <type>] [--name <service-name>]
                             [--description <description>]
                             [--enable | --disable]
                             <service>

Table 73.35. Positional Arguments
Value	Summary
<service>	Service to modify (type, name or id)

Table 73.36. Optional 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

73.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 73.37. Positional Arguments
Value	Summary
<service>	Service to display (type, name or id)

Table 73.38. Optional Arguments
Value	Summary
-h, --help	Show this help message and exit

Table 73.39. Output Formatters
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 73.40. JSON Formatter
Value	Summary
--noindent	Whether to disable indenting the json

Table 73.41. Shell Formatter
Value	Summary
--prefix PREFIX	Add a prefix to all variable names

Table 73.42. Table Formatter
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.

73.1. service create

73.2. service delete

73.3. service list

73.4. service provider create

73.5. service provider delete

73.6. service provider list

73.7. service provider set

73.8. service provider show

73.9. service set

73.10. service show

Learn

Try, buy, & sell

Communities

About Red Hat Documentation

Making open source more inclusive

About Red Hat

Red Hat legal and privacy links

Red Hat legal and privacy links