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

Expand
Table 32.1. Command arguments
ValueSummary

-h, --help

Show this help message and exit

Expand
Table 32.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

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

Expand
Table 32.3. CSV formatter options
ValueSummary

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

When to include quotes, defaults to nonnumeric

Expand
Table 32.4. JSON formatter options
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 32.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.

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

Expand
Table 32.6. Command arguments
ValueSummary

-h, --help

Show this help message and exit

Expand
Table 32.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

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

Expand
Table 32.8. CSV formatter options
ValueSummary

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

When to include quotes, defaults to nonnumeric

Expand
Table 32.9. JSON formatter options
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 32.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.

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

Expand
Table 32.11. Positional arguments
ValueSummary

<name>

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

Expand
Table 32.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 32.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

Expand
Table 32.14. JSON formatter options
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 32.15. Shell formatter options
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Expand
Table 32.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.

32.4. federation protocol delete

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 32.17. Positional arguments
ValueSummary

<federation-protocol>

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

Expand
Table 32.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)

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

Expand
Table 32.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 32.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

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

Expand
Table 32.21. CSV formatter options
ValueSummary

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

When to include quotes, defaults to nonnumeric

Expand
Table 32.22. JSON formatter options
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 32.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.

32.6. federation protocol set

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 32.24. Positional arguments
ValueSummary

<name>

Federation protocol to modify (name or id)

Expand
Table 32.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)

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

Expand
Table 32.26. Positional arguments
ValueSummary

<federation-protocol>

Federation protocol to display (name or id)

Expand
Table 32.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 32.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

Expand
Table 32.29. JSON formatter options
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 32.30. Shell formatter options
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Expand
Table 32.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.

맨 위로 이동
Red Hat logoGithubredditYoutubeTwitter

자세한 정보

평가판, 구매 및 판매

커뮤니티

Red Hat 문서 정보

Red Hat을 사용하는 고객은 신뢰할 수 있는 콘텐츠가 포함된 제품과 서비스를 통해 혁신하고 목표를 달성할 수 있습니다. 최신 업데이트를 확인하세요.

보다 포괄적 수용을 위한 오픈 소스 용어 교체

Red Hat은 코드, 문서, 웹 속성에서 문제가 있는 언어를 교체하기 위해 최선을 다하고 있습니다. 자세한 내용은 다음을 참조하세요.Red Hat 블로그.

Red Hat 소개

Red Hat은 기업이 핵심 데이터 센터에서 네트워크 에지에 이르기까지 플랫폼과 환경 전반에서 더 쉽게 작업할 수 있도록 강화된 솔루션을 제공합니다.

Theme

© 2025 Red Hat