Red Hat Summit Red Hat SummitSupportConsoleDevelopersStart a trialContact

Chapter 34. federation

This chapter describes the commands under the federation command.

34.1. federation domain list
Copy link

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]
                                        [--sort-ascending | --sort-descending]
Copy to Clipboard Toggle word wrap

Expand
Table 34.1. Command arguments
ValueSummary

-h, --help

Show this help message and exit

Expand
Table 34.2. Output formatter options
ValueSummary

-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 to show multiple columns

--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

--sort-ascending

Sort the column(s) in ascending order

--sort-descending

Sort the column(s) in descending order

Expand
Table 34.3. CSV formatter options
ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Expand
Table 34.4. JSON formatter options
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 34.5. Table formatter options
ValueSummary

--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
Copy link

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]
                                         [--sort-ascending | --sort-descending]
Copy to Clipboard Toggle word wrap

Expand
Table 34.6. Command arguments
ValueSummary

-h, --help

Show this help message and exit

Expand
Table 34.7. Output formatter options
ValueSummary

-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 to show multiple columns

--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

--sort-ascending

Sort the column(s) in ascending order

--sort-descending

Sort the column(s) in descending order

Expand
Table 34.8. CSV formatter options
ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Expand
Table 34.9. JSON formatter options
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 34.10. Table formatter options
ValueSummary

--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
Copy link

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>
Copy to Clipboard Toggle word wrap

Expand
Table 34.11. Positional arguments
ValueSummary

<name>

New federation protocol name (must be unique per identity provider)

Expand
Table 34.12. Command arguments
ValueSummary

-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)

Expand
Table 34.13. Output formatter options
ValueSummary

-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 to show multiple columns

Expand
Table 34.14. JSON formatter options
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 34.15. Shell formatter options
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Expand
Table 34.16. Table formatter options
ValueSummary

--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
Copy link

Delete federation protocol(s)

Usage:

openstack federation protocol delete [-h] --identity-provider
                                            <identity-provider>
                                            <federation-protocol>
                                            [<federation-protocol> ...]
Copy to Clipboard Toggle word wrap

Expand
Table 34.17. Positional arguments
ValueSummary

<federation-protocol>

Federation protocol(s) to delete (name or id)

Expand
Table 34.18. Command arguments
ValueSummary

-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
Copy link

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]
                                          [--sort-ascending | --sort-descending]
                                          --identity-provider
                                          <identity-provider>
Copy to Clipboard Toggle word wrap

Expand
Table 34.19. Command arguments
ValueSummary

-h, --help

Show this help message and exit

--identity-provider <identity-provider>

Identity provider to list (name or id) (required)

Expand
Table 34.20. Output formatter options
ValueSummary

-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 to show multiple columns

--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

--sort-ascending

Sort the column(s) in ascending order

--sort-descending

Sort the column(s) in descending order

Expand
Table 34.21. CSV formatter options
ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Expand
Table 34.22. JSON formatter options
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 34.23. Table formatter options
ValueSummary

--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
Copy link

Set federation protocol properties

Usage:

openstack federation protocol set [-h] --identity-provider
                                         <identity-provider>
                                         [--mapping <mapping>]
                                         <name>
Copy to Clipboard Toggle word wrap

Expand
Table 34.24. Positional arguments
ValueSummary

<name>

Federation protocol to modify (name or id)

Expand
Table 34.25. Command arguments
ValueSummary

-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
Copy link

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>
Copy to Clipboard Toggle word wrap

Expand
Table 34.26. Positional arguments
ValueSummary

<federation-protocol>

Federation protocol to display (name or id)

Expand
Table 34.27. Command arguments
ValueSummary

-h, --help

Show this help message and exit

--identity-provider <identity-provider>

Identity provider that supports <federation-protocol> (name or ID) (required)

Expand
Table 34.28. Output formatter options
ValueSummary

-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 to show multiple columns

Expand
Table 34.29. JSON formatter options
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 34.30. Shell formatter options
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Expand
Table 34.31. Table formatter options
ValueSummary

--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.

Back to top
Red Hat logoGithubredditYoutubeTwitter

Learn

Try, buy, & sell

Communities

About Red Hat Documentation

We help Red Hat users innovate and achieve their goals with our products and services with content they can trust. Explore our recent updates.

Making open source more inclusive

Red Hat is committed to replacing problematic language in our code, documentation, and web properties. For more details, see the Red Hat Blog.

About Red Hat

We deliver hardened solutions that make it easier for enterprises to work across platforms and environments, from the core datacenter to the network edge.

Theme

© 2025 Red Hat