Chapter 32. federation
This chapter describes the commands under the federation
command.
32.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 32.1. Command arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
Table 32.2. 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 32.3. CSV formatter options
Value | Summary |
---|---|
--quote {all,minimal,none,nonnumeric} | When to include quotes, defaults to nonnumeric |
Table 32.4. JSON formatter options
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 32.5. 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. |
32.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 32.6. Command arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
Table 32.7. 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 32.8. CSV formatter options
Value | Summary |
---|---|
--quote {all,minimal,none,nonnumeric} | When to include quotes, defaults to nonnumeric |
Table 32.9. JSON formatter options
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 32.10. 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. |
32.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 32.11. Positional arguments
Value | Summary |
---|---|
<name> | New federation protocol name (must be unique per identity provider) |
Table 32.12. Command 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 32.13. 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 32.14. JSON formatter options
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 32.15. Shell formatter options
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
Table 32.16. 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. |
32.4. federation protocol delete
Delete federation protocol(s)
Usage:
openstack federation protocol delete [-h] --identity-provider <identity-provider> <federation-protocol> [<federation-protocol> ...]
Table 32.17. Positional arguments
Value | Summary |
---|---|
<federation-protocol> | Federation protocol(s) to delete (name or id) |
Table 32.18. Command 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) |
32.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 32.19. Command arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
--identity-provider <identity-provider> | Identity provider to list (name or id) (required) |
Table 32.20. 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 32.21. CSV formatter options
Value | Summary |
---|---|
--quote {all,minimal,none,nonnumeric} | When to include quotes, defaults to nonnumeric |
Table 32.22. JSON formatter options
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 32.23. 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. |
32.6. federation protocol set
Set federation protocol properties
Usage:
openstack federation protocol set [-h] --identity-provider <identity-provider> [--mapping <mapping>] <name>
Table 32.24. Positional arguments
Value | Summary |
---|---|
<name> | Federation protocol to modify (name or id) |
Table 32.25. Command 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) |
32.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 32.26. Positional arguments
Value | Summary |
---|---|
<federation-protocol> | Federation protocol to display (name or id) |
Table 32.27. Command 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 32.28. 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 32.29. JSON formatter options
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 32.30. Shell formatter options
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
Table 32.31. 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. |