Virtual Private Cloud (VPC)¶

The VPC client is the command-line interface (CLI) for the Virtual Private Cloud (VPC) API and its extensions.

For help on a specific vpc command, enter:

$ openstack vpc help SUBCOMMAND

Vpc Peering Operations¶

vpc peering create¶

Create new Vpc Peering.

openstack vpc peering create
    [--description <description>]
    --local-router-id <local_router_id>
    --peer-router-id <peer_router_id>
    [--peer-project-id <peer_project_id>]
    <name>

--description <description>¶: Specifies the description of the VPC peering connection.

--local-router-id <local_router_id>¶: Specifies information about the local router_id involved in a VPC peering connection.

--peer-router-id <peer_router_id>¶: Specifies information about the peer router_id involved in a VPC peering connection.

--peer-project-id <peer_project_id>¶: Specifies the ID of the project to which a peer router belongs. It is required if the peer router is from different project.

name¶: Specifies the name of the VPC peering connection.

This command is provided by the otcextensions plugin.

vpc peering delete¶

Deletes VPC Peering.

openstack vpc peering delete <peering> [<peering> ...]

peering¶: VPC Peering(s) to delete (Name or ID)

This command is provided by the otcextensions plugin.

vpc peering list¶

List Vpc Peerings.

openstack vpc peering list
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [--id <id>]
    [--limit <limit>]
    [--marker <marker>]
    [--project-id <project_id>]
    [--name <name>]
    [--router-id <router_id>]
    [--status {PENDING_ACCEPTANCE,REJECTED,EXPIRED,DELETED,ACTIVE}]

--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>¶: Specifies the ID of the VPC peering connection.

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

--marker <marker>¶: Specifies the start resource ID of pagination query.

--project-id <project_id>¶: Specifies the project ID.

--name <name>¶: Specifies the Name of the VPC peering connection.

--router-id <router_id>¶: Specifies the router/vpc ID of requester/accepter of vpc peering.

--status {PENDING_ACCEPTANCE,REJECTED,EXPIRED,DELETED,ACTIVE}¶: Specifies the status of the VPC peering connection.

This command is provided by the otcextensions plugin.

vpc peering set¶

Accept VPC peering connection Request.

openstack vpc peering set [--accept | --reject] <peering>

--accept¶: Accept VPC peering connection request.

--reject¶: Reject VPC peering connection request.

peering¶: Specifies the Name or ID of the VPC peering connection.

This command is provided by the otcextensions plugin.

vpc peering show¶

Show VPC peering connection details.

openstack vpc peering show <peering>

peering¶: Specifies the Name or ID of the VPC peering connection.

This command is provided by the otcextensions plugin.

vpc peering update¶

Update a VPC peering connection.

openstack vpc peering update
    [--name <name>]
    [--description <description>]
    <peering>

--name <name>¶: Specifies the new name of the VPC peering connection.

--description <description>¶: Specifies the new descrition of the VPC peering connection.

peering¶: Specifies the Name or ID of the VPC peering connection.

This command is provided by the otcextensions plugin.

Vpc Route Operations¶

vpc route add¶

Add Vpc Route.

openstack vpc route add
    --destination <destination>
    --nexthop <nexthop>
    [--type <type>]
    --router-id <router_id>

--destination <destination>¶: Specifies the destination address in the CIDR notation format, for example, 192.168.200.0/24.

--nexthop <nexthop>¶: Specifies the next hop. If the type is peering, enter the VPC peering connection ID.

--type <type>¶: Specifies the route type. Currently, the value can only be peering.

--router-id <router_id>¶: Specifies the requesting router ID for creating a route.

This command is provided by the otcextensions plugin.

vpc route delete¶

Deletes VPC Route.

openstack vpc route delete <route> [<route> ...]

route¶: VPC Routes(s) ID to delete

This command is provided by the otcextensions plugin.

vpc route list¶

List Vpc Routes.

openstack vpc route list
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [--id <id>]
    [--limit <limit>]
    [--marker <marker>]
    [--project-id <project_id>]
    [--router-id <router_id>]
    [--destination <destination>]
    [--type <type>]

--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>¶: Specifies the ID of the VPC route.

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

--marker <marker>¶: Specifies the start resource ID of pagination query.

--project-id <project_id>¶: Specifies the project ID.

--router-id <router_id>¶: Specifies the router/vpc ID.

--destination <destination>¶: Specifies that the route destination address (CIDR) is used as the filtering condition.

--type <type>¶: Specifies that the type is used as the filtering condition. Currently, the value can only be peering.

This command is provided by the otcextensions plugin.

vpc route show¶

Show VPC Route Details.

openstack vpc route show <route>

route¶: Specifies the ID of the VPC route.

This command is provided by the otcextensions plugin.

last updated: 2023-06-12 09:35