Chapter 29. endpoint
Chapter 29. endpoint This chapter describes the commands under the endpoint command. 29.1. endpoint add project Associate a project to an endpoint Usage: Table 29.1. Positional arguments Value Summary <endpoint> Endpoint to associate with specified project (name or ID) <project> Project to associate with specified endpoint name or ID) Table 29.2. Command arguments Value Summary -h, --help Show this help message and exit --project-domain <project-domain> Domain the project belongs to (name or id). this can be used in case collisions between project names exist. 29.2. endpoint create Create new endpoint Usage: Table 29.3. Positional arguments Value Summary <service> Service to be associated with new endpoint (name or ID) <interface> New endpoint interface type (admin, public or internal) <url> New endpoint url Table 29.4. Command arguments Value Summary -h, --help Show this help message and exit --region <region-id> New endpoint region id --enable Enable endpoint (default) --disable Disable endpoint Table 29.5. 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 29.6. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 29.7. Shell formatter options Value Summary --prefix PREFIX Add a prefix to all variable names Table 29.8. 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. 29.3. endpoint delete Delete endpoint(s) Usage: Table 29.9. Positional arguments Value Summary <endpoint-id> Endpoint(s) to delete (id only) Table 29.10. Command arguments Value Summary -h, --help Show this help message and exit 29.4. endpoint group add project Add a project to an endpoint group Usage: Table 29.11. Positional arguments Value Summary <endpoint-group> Endpoint group (name or id) <project> Project to associate (name or id) Table 29.12. Command arguments Value Summary -h, --help Show this help message and exit --project-domain <project-domain> Domain the project belongs to (name or id). this can be used in case collisions between project names exist. 29.5. endpoint group create Create new endpoint group Usage: Table 29.13. Positional arguments Value Summary <name> Name of the endpoint group <filename> Filename that contains a new set of filters Table 29.14. Command arguments Value Summary -h, --help Show this help message and exit --description DESCRIPTION Description of the endpoint group Table 29.15. 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 29.16. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 29.17. Shell formatter options Value Summary --prefix PREFIX Add a prefix to all variable names Table 29.18. 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. 29.6. endpoint group delete Delete endpoint group(s) Usage: Table 29.19. Positional arguments Value Summary <endpoint-group> Endpoint group(s) to delete (name or id) Table 29.20. Command arguments Value Summary -h, --help Show this help message and exit 29.7. endpoint group list List endpoint groups Usage: Table 29.21. Command arguments Value Summary -h, --help Show this help message and exit --endpointgroup <endpoint-group> Endpoint group (name or id) --project <project> Project (name or id) --domain <domain> Domain owning <project> (name or id) Table 29.22. 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 29.23. CSV formatter options Value Summary --quote {all,minimal,none,nonnumeric} When to include quotes, defaults to nonnumeric Table 29.24. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 29.25. 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. 29.8. endpoint group remove project Remove project from endpoint group Usage: Table 29.26. Positional arguments Value Summary <endpoint-group> Endpoint group (name or id) <project> Project to remove (name or id) Table 29.27. Command arguments Value Summary -h, --help Show this help message and exit --project-domain <project-domain> Domain the project belongs to (name or id). this can be used in case collisions between project names exist. 29.9. endpoint group set Set endpoint group properties Usage: Table 29.28. Positional arguments Value Summary <endpoint-group> Endpoint group to modify (name or id) Table 29.29. Command arguments Value Summary -h, --help Show this help message and exit --name <name> New enpoint group name --filters <filename> Filename that contains a new set of filters --description <description> New endpoint group description 29.10. endpoint group show Display endpoint group details Usage: Table 29.30. Positional arguments Value Summary <endpointgroup> Endpoint group (name or id) Table 29.31. Command arguments Value Summary -h, --help Show this help message and exit Table 29.32. 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 29.33. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 29.34. Shell formatter options Value Summary --prefix PREFIX Add a prefix to all variable names Table 29.35. 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. 29.11. endpoint list List endpoints Usage: Table 29.36. Command arguments Value Summary -h, --help Show this help message and exit --service <service> Filter by service (type, name or id) --interface <interface> Filter by interface type (admin, public or internal) --region <region-id> Filter by region id --endpoint <endpoint-group> Endpoint to list filters --project <project> Project to list filters (name or id) --project-domain <project-domain> Domain the project belongs to (name or id). this can be used in case collisions between project names exist. Table 29.37. 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 29.38. CSV formatter options Value Summary --quote {all,minimal,none,nonnumeric} When to include quotes, defaults to nonnumeric Table 29.39. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 29.40. 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. 29.12. endpoint remove project Dissociate a project from an endpoint Usage: Table 29.41. Positional arguments Value Summary <endpoint> Endpoint to dissociate from specified project (name or ID) <project> Project to dissociate from specified endpoint name or ID) Table 29.42. Command arguments Value Summary -h, --help Show this help message and exit --project-domain <project-domain> Domain the project belongs to (name or id). this can be used in case collisions between project names exist. 29.13. endpoint set Set endpoint properties Usage: Table 29.43. Positional arguments Value Summary <endpoint-id> Endpoint to modify (id only) Table 29.44. Command arguments Value Summary -h, --help Show this help message and exit --region <region-id> New endpoint region id --interface <interface> New endpoint interface type (admin, public or internal) --url <url> New endpoint url --service <service> New endpoint service (name or id) --enable Enable endpoint --disable Disable endpoint 29.14. endpoint show Display endpoint details Usage: Table 29.45. Positional arguments Value Summary <endpoint> Endpoint to display (endpoint id, service id, service name, service type) Table 29.46. Command arguments Value Summary -h, --help Show this help message and exit Table 29.47. 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 29.48. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 29.49. Shell formatter options Value Summary --prefix PREFIX Add a prefix to all variable names Table 29.50. 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.
openstack endpoint add project [-h] [--project-domain <project-domain>] <endpoint> <project> openstack endpoint create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--region <region-id>] [--enable | --disable] <service> <interface> <url> openstack endpoint delete [-h] <endpoint-id> [<endpoint-id> ...] openstack endpoint group add project [-h] [--project-domain <project-domain>] <endpoint-group> <project> openstack endpoint group create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--description DESCRIPTION] <name> <filename> openstack endpoint group delete [-h] <endpoint-group> [<endpoint-group> ...] openstack endpoint group 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] [--endpointgroup <endpoint-group> | --project <project>] [--domain <domain>] openstack endpoint group remove project [-h] [--project-domain <project-domain>] <endpoint-group> <project> openstack endpoint group set [-h] [--name <name>] [--filters <filename>] [--description <description>] <endpoint-group> openstack endpoint group show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <endpointgroup> openstack endpoint 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] [--service <service>] [--interface <interface>] [--region <region-id>] [--endpoint <endpoint-group> | --project <project>] [--project-domain <project-domain>] openstack endpoint remove project [-h] [--project-domain <project-domain>] <endpoint> <project> openstack endpoint set [-h] [--region <region-id>] [--interface <interface>] [--url <url>] [--service <service>] [--enable | --disable] <endpoint-id> openstack endpoint show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <endpoint>