Search
SupportConsoleDevelopersStart a trialContact

Chapter 34. federation

download PDF

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
ValueSummary

-h, --help

Show this help message and exit

Table 34.2. Output Formatters
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

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

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

When to include quotes, defaults to nonnumeric

Table 34.4. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

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

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
ValueSummary

-h, --help

Show this help message and exit

Table 34.7. Output Formatters
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

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

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

When to include quotes, defaults to nonnumeric

Table 34.9. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

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

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
ValueSummary

<name>

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

Table 34.12. Optional 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)

Table 34.13. Output Formatters
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

Table 34.14. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Table 34.15. Shell Formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

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

Delete federation protocol(s)

Usage:

openstack federation protocol delete [-h] --identity-provider
                                            <identity-provider>
                                            <federation-protocol>
                                            [<federation-protocol> ...]

Table 34.17. Positional Arguments
ValueSummary

<federation-protocol>

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

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

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
ValueSummary

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

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

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

When to include quotes, defaults to nonnumeric

Table 34.22. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

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

Set federation protocol properties

Usage:

openstack federation protocol set [-h] --identity-provider
                                         <identity-provider>
                                         [--mapping <mapping>]
                                         <name>

Table 34.24. Positional Arguments
ValueSummary

<name>

Federation protocol to modify (name or id)

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

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
ValueSummary

<federation-protocol>

Federation protocol to display (name or id)

Table 34.27. Optional Arguments
ValueSummary

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

Table 34.29. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Table 34.30. Shell Formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

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

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.

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.

© 2024 Red Hat, Inc.