Chapter 34. federation
This chapter describes the commands under the federation
command.
34.1. federation domain list
List accessible domains
Usage:
openstack federation domain 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 34.1. Optional Arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
Table 34.2. 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 34.3. CSV Formatter
Value | Summary |
---|---|
--quote {all,minimal,none,nonnumeric} | When to include quotes, defaults to nonnumeric |
Table 34.4. JSON Formatter
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 34.5. 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. |
34.2. federation project list
List accessible projects
Usage:
openstack federation project 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 34.6. Optional Arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
Table 34.7. 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 34.8. CSV Formatter
Value | Summary |
---|---|
--quote {all,minimal,none,nonnumeric} | When to include quotes, defaults to nonnumeric |
Table 34.9. JSON Formatter
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 34.10. 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. |
34.3. federation protocol create
Create new federation protocol
Usage:
openstack federation protocol create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] --identity-provider <identity-provider> --mapping <mapping> <name>
Table 34.11. Positional Arguments
Value | Summary |
---|---|
<name> | New federation protocol name (must be unique per identity provider) |
Table 34.12. Optional Arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
--identity-provider <identity-provider> | Identity provider that will support the new federation protocol (name or ID) (required) |
--mapping <mapping> | Mapping that is to be used (name or id) (required) |
Table 34.13. 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 34.14. JSON Formatter
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 34.15. Shell Formatter
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
Table 34.16. 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. |
34.4. federation protocol delete
Delete federation protocol(s)
Usage:
openstack federation protocol delete [-h] --identity-provider <identity-provider> <federation-protocol> [<federation-protocol> ...]
Table 34.17. Positional Arguments
Value | Summary |
---|---|
<federation-protocol> | Federation protocol(s) to delete (name or id) |
Table 34.18. Optional Arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
--identity-provider <identity-provider> | Identity provider that supports <federation-protocol> (name or ID) (required) |
34.5. federation protocol list
List federation protocols
Usage:
openstack federation protocol 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] --identity-provider <identity-provider>
Table 34.19. Optional Arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
--identity-provider <identity-provider> | Identity provider to list (name or id) (required) |
Table 34.20. 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 34.21. CSV Formatter
Value | Summary |
---|---|
--quote {all,minimal,none,nonnumeric} | When to include quotes, defaults to nonnumeric |
Table 34.22. JSON Formatter
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 34.23. 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. |
34.6. federation protocol set
Set federation protocol properties
Usage:
openstack federation protocol set [-h] --identity-provider <identity-provider> [--mapping <mapping>] <name>
Table 34.24. Positional Arguments
Value | Summary |
---|---|
<name> | Federation protocol to modify (name or id) |
Table 34.25. Optional Arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
--identity-provider <identity-provider> | Identity provider that supports <federation-protocol> (name or ID) (required) |
--mapping <mapping> | Mapping that is to be used (name or id) |
34.7. federation protocol show
Display federation protocol details
Usage:
openstack federation protocol show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] --identity-provider <identity-provider> <federation-protocol>
Table 34.26. Positional Arguments
Value | Summary |
---|---|
<federation-protocol> | Federation protocol to display (name or id) |
Table 34.27. Optional Arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
--identity-provider <identity-provider> | Identity provider that supports <federation-protocol> (name or ID) (required) |
Table 34.28. 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 34.29. JSON Formatter
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 34.30. Shell Formatter
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
Table 34.31. 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. |