OpenStack Client Tools

osc network vpn vpnservice list

Lists all VPN services.

The list might be empty.

Standard query parameters are supported on the URI. For more information, see Filtering and Column Selection.

Use the fields query parameter to control which fields are returned in the response body. For more information, see Fields.

Pagination query parameters are supported if Neutron configuration supports it by overriding allow_pagination=false. For more information, see Pagination.

Sorting query parameters are supported if Neutron configuration supports it with allow_sorting=true. For more information, see Sorting.

Normal response codes: 200

Error response codes: 401, 403

Usage: osc network vpn vpnservice list [OPTIONS]

Options:

• --admin-state-up <ADMIN_STATE_UP> — admin_state_up query parameter for /v2.0/vpn/vpnservices API

  Possible values: true, false

• --description <DESCRIPTION> — description query parameter for /v2.0/vpn/vpnservices API

• --external-v4-ip <EXTERNAL_V4_IP> — external_v4_ip query parameter for /v2.0/vpn/vpnservices API

• --external-v6-ip <EXTERNAL_V6_IP> — external_v6_ip query parameter for /v2.0/vpn/vpnservices API

• --flavor-id <FLAVOR_ID> — flavor_id query parameter for /v2.0/vpn/vpnservices API

• --id <ID> — id query parameter for /v2.0/vpn/vpnservices API

• --page-size <LIMIT> — Requests a page size of items. Returns a number of items up to a limit value. Use the limit parameter to make an initial limited request and use the ID of the last-seen item from the response as the marker parameter value in a subsequent limited request

• --marker <MARKER> — The ID of the last-seen item. Use the limit parameter to make an initial limited request and use the ID of the last-seen item from the response as the marker parameter value in a subsequent limited request

• --name <NAME> — name query parameter for /v2.0/vpn/vpnservices API

• --page-reverse <PAGE_REVERSE> — Reverse the page direction

  Possible values: true, false

• --router-id <ROUTER_ID> — router_id query parameter for /v2.0/vpn/vpnservices API

• --sort-dir <SORT_DIR> — Sort direction. This is an optional feature and may be silently ignored by the server

• --sort-key <SORT_KEY> — Sort results by the attribute. This is an optional feature and may be silently ignored by the server

• --status <STATUS> — status query parameter for /v2.0/vpn/vpnservices API

• --subnet-id <SUBNET_ID> — subnet_id query parameter for /v2.0/vpn/vpnservices API

• --tenant-id <TENANT_ID> — tenant_id query parameter for /v2.0/vpn/vpnservices API

• --max-items <MAX_ITEMS> — Total limit of entities count to return. Use this when there are too many entries

  Default value: 10000