Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

osc network vpn ipsec-site-connection list

Lists all IPsec connections.

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 ipsec-site-connection list [OPTIONS]

Options:

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

    Possible values: true, false

  • --auth-mode <AUTH_MODE> — auth_mode query parameter for /v2.0/vpn/ipsec-site-connections API

    Possible values: psk

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

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

  • --ikepolicy-id <IKEPOLICY_ID> — ikepolicy_id query parameter for /v2.0/vpn/ipsec-site-connections API

  • --initiator <INITIATOR> — initiator query parameter for /v2.0/vpn/ipsec-site-connections API

    Possible values: bi-directional, response-only

  • --ipsecpolicy-id <IPSECPOLICY_ID> — ipsecpolicy_id query parameter for /v2.0/vpn/ipsec-site-connections 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

  • --local-ep-group-id <LOCAL_EP_GROUP_ID> — local_ep_group_id query parameter for /v2.0/vpn/ipsec-site-connections API

  • --local-id <LOCAL_ID> — local_id query parameter for /v2.0/vpn/ipsec-site-connections API

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

  • --mtu <MTU> — mtu query parameter for /v2.0/vpn/ipsec-site-connections API

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

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

    Possible values: true, false

  • --peer-address <PEER_ADDRESS> — peer_address query parameter for /v2.0/vpn/ipsec-site-connections API

  • --peer-ep-group-id <PEER_EP_GROUP_ID> — peer_ep_group_id query parameter for /v2.0/vpn/ipsec-site-connections API

  • --peer-id <PEER_ID> — peer_id query parameter for /v2.0/vpn/ipsec-site-connections API

  • --psk <PSK> — psk query parameter for /v2.0/vpn/ipsec-site-connections API

  • --route-mode <ROUTE_MODE> — route_mode query parameter for /v2.0/vpn/ipsec-site-connections 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/ipsec-site-connections API

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

  • --vpnservice-id <VPNSERVICE_ID> — vpnservice_id query parameter for /v2.0/vpn/ipsec-site-connections API

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

    Default value: 10000