Direct Connect (DCAAS)¶

The DCAAS client is the command-line interface (CLI) for the Network Direct Connection (DCAAS) API and its extensions.

For help on a specific dcaas command, enter:

$ openstack dcaas help SUBCOMMAND

Direct Connect Operations¶

dcaas connection create¶

Create new Direct Connection

openstack dcaas connection create
    [--name <name>]
    [--description <description>]
    [--peer_location <peer_location>]
    [--device_id <device_id>]
    [--interface_name <interface_name>]
    [--redundant_id <redundant_id>]
    [--provider_status <provider_status>]
    [--type <type>]
    [--hosting_id <hosting_id>]
    [--vlan <vlan>]
    [--charge_mode <charge_mode>]
    [--order_id <order_id>]
    [--product_id <product_id>]
    [--status <status>]
    [--admin_state_up <admin_state_up>]
    <port_type>
    <bandwidth>
    <location>
    <provider>

--name <name>¶: Specified the name of Direct Connection.

--description <description>¶: Provides supplementary information about the connection.

--peer_location <peer_location>¶: Specifies the location of the on-premises facility at the other end of the connection, specific to the street or data center name.

--device_id <device_id>¶: Specifies the gateway device ID of the Direct Connection.

--interface_name <interface_name>¶: Specifies the name of the interface accessed by the Direct Connection.

--redundant_id <redundant_id>¶: Specifies the ID of the redundant connection using the same gateway.

--provider_status <provider_status>¶: Specifies the status of the carrier’s leased line. The value can be ACTIVE or DOWN.

--type <type>¶: Specifies the connection type. The value can be hosted.

--hosting_id <hosting_id>¶: Specifies the ID of the operations connection on which the hosted connection is created.

--vlan <vlan>¶: Specifies the VLAN pre-allocated to the hosted connection.

--charge_mode <charge_mode>¶: Specifies the billing mode. The value can be prepayment, bandwidth, or traffic.

--order_id <order_id>¶: Specifies the order number of the connection.

--product_id <product_id>¶: Specifies the product ID corresponding to the connection’s order.

--status <status>¶: Specifies the connection status. The value can be ACTIVE, DOWN, BUILD, ERROR, PENDING_DELETE, DELETED, APPLY, DENY, PENDING_PAY, PAID, ORDERING, ACCEPT, or REJECTED.

--admin_state_up <admin_state_up>¶: Specifies the administrative status of the connection. The value can be true or false.

port_type¶: Specified the port type of Direct Connection. The value can be 1G or 10G.

bandwidth¶: Specified the bandwidth of Direct Connection in Mbit/s.

location¶: Specified the access location of Direct Connection.

provider¶: Specifies the carrier who provides the leased line.

This command is provided by the otcextensions plugin.

dcaas connection delete¶

Delete the Direct Connection.

openstack dcaas connection delete <direct_connection>

direct_connection¶: Direct Connection to delete.

This command is provided by the otcextensions plugin.

dcaas connection list¶

List of Direct Connections.

openstack dcaas connection list
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [--id <id>]
    [--name <name>]
    [--port_type <port_type>]
    [--bandwidth <bandwidth>]
    [--location <location>]
    [--peer_location <peer_location>]
    [--device_id <device_id>]
    [--interface_name <interface_name>]
    [--redundant_id <redundant_id>]
    [--provider <provider>]
    [--provider_status <provider_status>]
    [--type <type>]
    [--hosting_id <hosting_id>]
    [--vlan <vlan>]
    [--charge_mode <charge_mode>]
    [--apply_time <apply_time>]
    [--create_time <create_time>]
    [--delete_time <delete_time>]
    [--order_id <order_id>]
    [--product_id <product_id>]
    [--status <status>]
    [--admin_state_up <admin_state_up>]

--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 Direct Connection.

--name <name>¶: Specified the name of Direct Connection.

--port_type <port_type>¶: Specified the port type of Direct Connection. The value can be 1G or 10G.

--bandwidth <bandwidth>¶: Specified the bandwidth of Direct Connection in Mbit/s.

--location <location>¶: Specified the access location of Direct Connection.

--peer_location <peer_location>¶: Specifies the location of the on-premises facility at the other end of the connection, specific to the street or data center name.

--device_id <device_id>¶: Specifies the gateway device ID of the Direct Connection.

--interface_name <interface_name>¶: Specifies the name of the interface accessed by the Direct Connection.

--redundant_id <redundant_id>¶: Specifies the ID of the redundant connection using the same gateway.

--provider <provider>¶: Specifies the carrier who provides the leased line.

--provider_status <provider_status>¶: Specifies the status of the carrier’s leased line. The value can be ACTIVE or DOWN.

--type <type>¶: Specifies the connection type. The value can be hosted.

--hosting_id <hosting_id>¶: Specifies the ID of the operations connection on which the hosted connection is created.

--vlan <vlan>¶: Specifies the VLAN pre-allocated to the hosted connection.

--charge_mode <charge_mode>¶: Specifies the billing mode. The value can be prepayment, bandwidth, or traffic.

--apply_time <apply_time>¶: Specifies the time when the connection is requested.

--create_time <create_time>¶: Specifies the time when the connection is created.

--delete_time <delete_time>¶: Specifies the time when the connection is deleted.

--order_id <order_id>¶: Specifies the order number of the connection.

--product_id <product_id>¶: Specifies the product ID corresponding to the connection’s order.

--status <status>¶: Specifies the connection status. The value can be ACTIVE, DOWN, BUILD, ERROR, PENDING_DELETE, DELETED, APPLY, DENY, PENDING_PAY, PAID, ORDERING, ACCEPT, or REJECTED.

--admin_state_up <admin_state_up>¶: Specifies the administrative status of the connection.The value can be true or false.

This command is provided by the otcextensions plugin.

dcaas connection show¶

Show Direct Connection details.

openstack dcaas connection show <direct_connection>

direct_connection¶: Specifies the connection ID or name.

This command is provided by the otcextensions plugin.

dcaas connection update¶

Update a Direct Connection

openstack dcaas connection update
    [--name <name>]
    [--description <description>]
    [--bandwidth <bandwidth>]
    [--provider_status <provider_status>]
    [--order_id <order_id>]
    [--product_id <product_id>]
    <direct_connection>

--name <name>¶: Specifies the connection name.

--description <description>¶: Provides supplementary information about the connection.

--bandwidth <bandwidth>¶: Specifies the bandwidth of the connection in Mbit/s. The value can be 1G or 10G.

--provider_status <provider_status>¶: Specifies the status of the carrier’s leased line. The value can be ACTIVE or DOWN.

--order_id <order_id>¶: Specifies the order number of the connection.

--product_id <product_id>¶: Specifies the product ID corresponding to the connection’s order.

direct_connection¶: Specifies the connection ID or name.

This command is provided by the otcextensions plugin.

Direct Connect Endpoint Group Operations¶

dcaas endpoint group create¶

Create new Direct Connection Endpoint Group.

openstack dcaas endpoint group create
    [--name <name>]
    [--description <description>]
    <project_id>
    <type>
    <endpoint>
    [<endpoint> ...]

--name <name>¶: Specifies the name of the Direct Connect Endpoint Group.

--description <description>¶: Provides supplementary information about the Direct Connect Endpoint Group.

project_id¶: Specifies the project ID.

type¶: Specifies the type of the Direct Connect endpoints.The value can only be cidr.

endpoint¶: Specifies the list of the endpoints in a Direct Connect Endpoint Group.

This command is provided by the otcextensions plugin.

dcaas endpoint group delete¶

Delete the Direct Connect Endpoint Group.

openstack dcaas endpoint group delete <endpoint_group>

endpoint_group¶: Direct Connect Endpoint Group to delete.

This command is provided by the otcextensions plugin.

dcaas endpoint group list¶

List of Direct Connect Endpoint Groups.

openstack dcaas endpoint group list
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [--id <id>]
    [--name <name>]
    [--description <description>]
    [--project_id <project_id>]
    [--type <type>]
    [--endpoints <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

--id <id>¶: Specifies the ID of the Direct Connect Endpoint Group.

--name <name>¶: Specifies the name of the Direct Connect Endpoint Group.

--description <description>¶: Provides supplementary information about the Direct Connect Endpoint Group.

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

--type <type>¶: Specifies the type of the Direct Connect endpoints.The value can only be cidr.

--endpoints <endpoint>¶: Specifies the list of the endpoints in a Direct Connect Endpoint Group.

This command is provided by the otcextensions plugin.

dcaas endpoint group show¶

Show Direct Connection Endpoint Group.

openstack dcaas endpoint group show <endpoint_group>

endpoint_group¶: Specifies the endpoint group ID or name.

This command is provided by the otcextensions plugin.

dcaas endpoint group update¶

Update a Direct Connect Endpoint Group.

openstack dcaas endpoint group update
    [--name <name>]
    [--description <description>]
    <endpoint_group>

--name <name>¶: Specifies the name of the Direct Connect Endpoint Group.

--description <description>¶: Provides supplementary information about the Direct Connect Endpoint Group.

endpoint_group¶: Specifies the Endpoint Group ID or name.

This command is provided by the otcextensions plugin.

Virtual Gateway Operations¶

dcaas gateway create¶

Create new Virtual Gateway.

openstack dcaas gateway create
    [--name <name>]
    [--description <description>]
    [--device_id <device_id>]
    [--redundant_device_id <redundant_device_id>]
    [--type <type>]
    [--ipsec_bandwidth <ipsec_bandwidth>]
    [--bgp_asn <bgp_asn>]
    [--admin_state_up <admin_state_up>]
    <vpc_id>
    <local_ep_group_id>

--name <name>¶: Specifies the Virtual Gateway name.

--description <description>¶: Provides supplementary information about the Virtual Gateway.

--device_id <device_id>¶: Specifies the ID of the physical device used by the Virtual Gateway.

--redundant_device_id <redundant_device_id>¶: Specifies the ID of the redundant physical device used by the Virtual Gateway.

--type <type>¶: Specifies the Virtual Gateway type. The value can be default or double ipsec.

--ipsec_bandwidth <ipsec_bandwidth>¶: Specifies the bandwidth provided for IPsec VPN in Mbit/s.

--bgp_asn <bgp_asn>¶: Specifies the BGP ASN of the Virtual Gateway.

--admin_state_up <admin_state_up>¶: Specifies the administrative status of the Virtual Gateway.

vpc_id¶: Specifies the ID of the VPC to be accessed.

local_ep_group_id¶: Specifies the ID of the local endpoint group that records CIDR blocks of the VPC subnets.

This command is provided by the otcextensions plugin.

dcaas gateway delete¶

Delete the Virtual Gateway.

openstack dcaas gateway delete <virtual_gateway>

virtual_gateway¶: Virtual Gateway to delete.

This command is provided by the otcextensions plugin.

dcaas gateway list¶

List of Virtual Gateways.

openstack dcaas gateway list
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [--id <id>]
    [--name <name>]
    [--vpc_id <vpc_id>]
    [--local_ep_group_id <local_ep_group_id>]
    [--description <description>]
    [--device_id <device_id>]
    [--redundant_device_id <redundant_device_id>]
    [--type <type>]
    [--bgp_asn <bgp_asn>]
    [--ipsec_bandwidth <ipsec_bandwidth>]
    [--status <status>]
    [--admin_state_up <admin_state_up>]

--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 Virtual Gateway ID.

--name <name>¶: Specifies the Virtual Gateway name.

--vpc_id <vpc_id>¶: Specifies the ID of the VPC to be accessed.

--local_ep_group_id <local_ep_group_id>¶: Specifies the ID of the local endpoint group that records CIDR blocks of the VPC subnets.

--description <description>¶: Provides supplementary information about the Virtual Gateway.

--device_id <device_id>¶: Specifies the ID of the physical device used by the Virtual Gateway.

--redundant_device_id <redundant_device_id>¶: Specifies the ID of the redundant physical device used by the Virtual Gateway.

--type <type>¶: Specifies the Virtual Gateway type. The value can be default or double ipsec.

--bgp_asn <bgp_asn>¶: Specifies the BGP ASN of the Virtual Gateway.

--ipsec_bandwidth <ipsec_bandwidth>¶: Specifies the bandwidth provided for IPsec VPN in Mbit/s.

--status <status>¶: Specifies the Virtual Gateway status. The value can be ACTIVE, DOWN, BUILD, ERROR, PENDING_CREATE, PENDING_UPDATE, or PENDING_DELETE.

--admin_state_up <admin_state_up>¶: Specifies the administrative status of the Virtual Gateway. The value can be true or false.

This command is provided by the otcextensions plugin.

dcaas gateway show¶

Show Virtual Gateway details.

openstack dcaas gateway show <virtual_gateway>

virtual_gateway¶: Specifies the Virtual Gateway ID or name.

This command is provided by the otcextensions plugin.

dcaas gateway update¶

Update a Virtual Gateway.

openstack dcaas gateway update
    [--name <name>]
    [--description <description>]
    [--local_ep_group_id <local_ep_group_id>]
    <virtual_gateway>

--name <name>¶: Specifies the Virtual Gateway name.

--description <description>¶: Provides supplementary information about the Virtual Gateway.

--local_ep_group_id <local_ep_group_id>¶: Specifies the ID of the local endpoint group that records CIDR blocks of the VPC subnets.

virtual_gateway¶: Specifies the Virual Gateway ID or name.

This command is provided by the otcextensions plugin.

last updated: 2023-08-18 10:18