VPC Endpoint Service (VPCEP)¶

The VPCEP client is the command-line interface (CLI) for the VPC Endpoint Service (VPCEP) API and its extensions.

For help on a specific vpcep command, enter:

$ openstack vpcep help SUBCOMMAND

Vpcep Endpoint Operations¶

vpcep endpoint create¶

Create a VPC endpoint for accessing a VPC endpoint service.

openstack vpcep endpoint create
    [--service-id <service_id>]
    --router-id <router_id>
    --network-id <network_id>
    [--port-ip <port_ip>]
    [--route-tables <route_tables> [<route_tables> ...]]
    [--whitelist <whitelist> [<whitelist> ...]]
    [--specification-name <specification_name>]
    [--description <description>]
    [--tags key=<tag-key>,value=<tag-value>]
    [--enable-dns]
    [--enable-whitelist]

--service-id <service_id>¶: ID of the Vpc endpoint service.

--router-id <router_id>¶: ID of the vpc/router where the VPC endpoint is to be created.

--network-id <network_id>¶: ID of the network created in the vpc/router.

--port-ip <port_ip>¶: IP address for accessing the associated VPC endpoint service.

--route-tables <route_tables>¶: Lists the IDs of route tables.

--whitelist <whitelist>¶: Whitelist for controlling access to the VPC endpoint.

--specification-name <specification_name>¶: Name of the VPC endpoint specifications.

--description <description>¶: Description of the VPC endpoint.

--tags key=<tag-key>,value=<tag-value>¶: Example: –tags key=test-key,value=test-value Repeat option to provide multiple tags.

--enable-dns¶: Whether to create a private domain name. default (false)

--enable-whitelist¶: Whether access control is enabled.

This command is provided by the otcextensions plugin.

vpcep endpoint delete¶

Delete VPC endpoint(s).

openstack vpcep endpoint delete <endpoint> [<endpoint> ...]

endpoint¶: ID of vpc endpoint(s) to delete.

This command is provided by the otcextensions plugin.

vpcep endpoint list¶

List VPC Endpoints.

openstack vpcep endpoint list
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [--id <id>]
    [--service-name <service_name>]
    [--sort-key {created_at, updated_at}]
    [--sort-dir {asc, desc}]
    [--limit <limit>]
    [--offset <offset>]

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

--id <id>¶: ID of the VPC endpoint.

--service-name <service_name>¶: Name of the VPC endpoint service.

--sort-key {created_at, updated_at}¶: Sorting field of the VPC endpoint list.

--sort-dir {asc, desc}¶: Sorting order of the VPC endpoint list.

--limit <limit>¶: Limit number of VPC endpoints.

--offset <offset>¶: Endpoints after this offset will be queried.

This command is provided by the otcextensions plugin.

vpcep endpoint show¶

Show VPC endpoint details.

openstack vpcep endpoint show <endpoint>

endpoint¶: ID of the VPC endpoint.

This command is provided by the otcextensions plugin.

Vpcep Service Operations¶

vpcep service connection list¶

List VPC Endpoint Service Connections.

openstack vpcep service connection list
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [--id <id>]
    [--marker-id <marker_id>]
    [--sort-key {created_at, updated_at}]
    [--sort-dir {asc, desc}]
    [--limit <limit>]
    [--offset <offset>]
    <service>

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

--id <id>¶: VPC Endpoint ID.

--marker-id <marker_id>¶: Packet ID of the VPC endpoint.

--sort-key {created_at, updated_at}¶: Sorting field of the VPC endpoint service list.

--sort-dir {asc, desc}¶: Sorting order of the VPC endpoint service list.

--limit <limit>¶: Limit number of endpoint connections queried.

--offset <offset>¶: Connection records after this Offset will be queried.

service¶: ID or name of the VPC Endpoint Service.

This command is provided by the otcextensions plugin.

vpcep service connection set¶

Manage VPC Endpoint Service Connections.

openstack vpcep service connection set
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    (--accept | --reject)
    <service>
    <endpoint>
    [<endpoint> ...]

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

--accept¶: Accept VPC Endpoint Connection to Endpoint Service.

--reject¶: Reject VPC Endpoint Connection to Endpoint Service.

service¶: ID or name of the VPC Endpoint Service.

endpoint¶: VPC Endpoint(s) ID to Accept Or Reject Connection to Service.

This command is provided by the otcextensions plugin.

vpcep service create¶

Create new VPC Endpoint Service.

openstack vpcep service create
    --port-id <port_id>
    [--pool-id <pool_id>]
    --router-id <router_id>
    --server-type
    {LB,
    VM,
    VIP,
    BMS}
    [--service-type {gateway, interface}]
    --ports client_port
    =<client-port>,server_port=<server-port>,protocol=<protocol>
    [--tcp-proxy {close, toa_open, proxy_open, open, proxy_vni}]
    [--tags key=<tag-key>,value=<tag-value>]
    [--disable-approval]
    <name>

--port-id <port_id>¶: Specify the ID for identifying the backend resource of the VPC endpoint service.

--pool-id <pool_id>¶: Specify the ID of the cluster associated with the target VPCEP resource.

--router-id <router_id>¶: ID of the router (VPC) to which the backend resource of the VPC endpoint service belongs.

--server-type {LB, VM, VIP, BMS}¶: Specifies the resource type.

--service-type {gateway, interface}¶: Specifies the type of the VPC endpoint service.

--ports client_port=<client-port>,server_port=<server-port>,protocol=<protocol>¶: Example: –ports client_port=8081,server_port=22,protocol=TCP Repeat option to provide multiple ports.

--tcp-proxy {close, toa_open, proxy_open, open, proxy_vni}¶: Whether the client IP address and port number or marker_id information is transmitted to the server.

--tags key=<tag-key>,value=<tag-value>¶: Example: –tags key=test-key,value=test-value Repeat option to provide multiple tags.

--disable-approval¶: Specifies whether connection approval is required.

name¶: Specifies name of the Endpoint Service.

This command is provided by the otcextensions plugin.

vpcep service delete¶

Deletes VPC Endpoint Service.

openstack vpcep service delete <service> [<service> ...]

service¶: Vpc Endpoint Services(s) to delete (Name or ID)

This command is provided by the otcextensions plugin.

vpcep service list¶

List VPC Endpoint Services.

openstack vpcep service list
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [--id <id>]
    [--name <name>]
    [--status <status>]
    [--sort-key {created_at, updated_at}]
    [--sort-dir {asc, desc}]
    [--limit <limit>]
    [--offset <offset>]

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

--id <id>¶: ID of the VPC Endpoint Service.

--name <name>¶: Name of the VPC Endpoint Service.

--status <status>¶: Status of the VPC endpoint service.

--sort-key {created_at, updated_at}¶: Sorting field of the VPC endpoint service list.

--sort-dir {asc, desc}¶: Sorting order of the VPC endpoint service list.

--limit <limit>¶: Limit number of VPC endpoint services displayed.

--offset <offset>¶: Service records after this Offset will be queried.

This command is provided by the otcextensions plugin.

vpcep service show¶

Show VPC Endpoint Service Details.

openstack vpcep service show <service>

service¶: Name or ID of the VPC Endpoint Service.

This command is provided by the otcextensions plugin.

vpcep service update¶

Update a Endpoint Service.

openstack vpcep service update
    [--name <name>]
    [--ports client_port=<client-port>,server_port=<server-port>,protocol=<protocol>]
    [--port-id <port_id>]
    [--tcp-proxy {close, toa_open, proxy_open, open, proxy_vni}]
    [--enable-approval | --disable-approval]
    <service>

--name <name>¶: Name of the VPC endpoint service.

--ports client_port=<client-port>,server_port=<server-port>,protocol=<protocol>¶: Example: –ports client_port=8081,server_port=22,protocol=TCP Repeat option to provide multiple ports.

--port-id <port_id>¶: Specify the ID for identifying the backend resource of the VPC endpoint service.

--tcp-proxy {close, toa_open, proxy_open, open, proxy_vni}¶: Whether the client IP address and port number or marker_id information is transmitted to the server.

--enable-approval¶: Connection approval is required.

--disable-approval¶: Connection approval is not required.

service¶: Name or ID of the Vpc endpoint service.

This command is provided by the otcextensions plugin.

vpcep service whitelist list¶

List whitelist records of a VPC endpoint service.

openstack vpcep service whitelist list
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [--sort-key {created_at}]
    [--sort-dir {asc, desc}]
    [--limit <limit>]
    [--offset <offset>]
    <service>

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

--sort-key {created_at}¶: Sorting field of the whitelist records.

--sort-dir {asc, desc}¶: Sorting order of the whitelist record list.

--limit <limit>¶: Limit number of whitelist records to fetch.

--offset <offset>¶: Whitelist records after this Offset will be queried.

service¶: ID or name of the VPC Endpoint Service.

This command is provided by the otcextensions plugin.

vpcep service whitelist set¶

Manage whitelist records of a VPC endpoint service.

openstack vpcep service whitelist set
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    (--add | --remove)
    <service>
    <domain>
    [<domain> ...]

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

--add¶: Add a domian to the whitelist record of the Vpc endpoint service.

--remove¶: Remove a domian from the whitelist record of the Vpc endpoint service.

service¶: ID or name of the VPC Endpoint Service.

domain¶: Domain ID(s) to add to whitelist record of the Vpc endpoint service.

This command is provided by the otcextensions plugin.

Vpcep Quota Operations¶

vpcep quota list¶

List VPC endpoint resource quotas.

openstack vpcep quota list
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [--type {endpoint, endpoint_service}]

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

--type {endpoint, endpoint_service}¶: Specify the resource type.

This command is provided by the otcextensions plugin.

last updated: 2024-05-18 00:15