Create VRF Context Profile (v2.0)

POST 
/v2.0/api/tenants/:tenant_id/vrfcontextprofiles

Create a new VRF context profile.

Request

Path Parameters

tenant_id stringrequired

ID of the tenant.

application/json

Body

VRF Context Profile Request

default_vrf_context_profile boolean

Default Vrf Context Profile: JsonIgnore(value = true)

description

Description of the VRF profile. Max size = 256.

id string

The VRF profile ID.

name stringrequired

The name of the VRF profile. Max size = 128.

tags string[]

A information field that can be added to identify the VRF profile. Maximum 10 unique tags of length 1024 each are allowed.

vrf_context_ids string[]

The VRF context IDs.

vrf_context_route_leak_rules VRFContextRouteLeakRule[]
The valid VRF context leak rules.
Array [
description
Description of the Route Leak Rule. Max size = 256.
dest_vrf_context_id string
The destination VRF ID for the Route Leak Rule.
ipv4_prefixes string[]
The leaked IPv4 prefixes of the Route Leak Rule. The leaked IPv4 prefix in the route leak rule must match the prefix configured on the interface.
name string
The name of the Route Leak Rule. Max size = 128.
src_vrf_context_id string
The SRC VRF ID.
]

Responses

200

Successful Operation

application/json

Schema

Schema

default_vrf_context_profile boolean

VRF profile is enabled by default. True / False.

description

Description of the VRF profile. Max size = 256.

id string

The VRF profile ID.

name stringrequired

The name of the VRF profile. Max size = 128.

tags string[]

A information field that can be added to identify the VRF profile. Maximum 10 unique tags of length 1024 each are allowed.

vrf_context_ids string[]

The VRF context IDs.

vrf_context_route_leak_rules VRFContextRouteLeakRule[]
The valid VRF context leak rules.
Array [
description
Description of the Route Leak Rule. Max size = 256.
dest_vrf_context_id string
The destination VRF ID for the Route Leak Rule.
ipv4_prefixes string[]
The leaked IPv4 prefixes of the Route Leak Rule. The leaked IPv4 prefix in the route leak rule must match the prefix configured on the interface.
name string
The name of the Route Leak Rule. Max size = 128.
src_vrf_context_id string
The SRC VRF ID.
]

Example (from schema)

{
  "default_vrf_context_profile": true,
  "id": "string",
  "name": "string",
  "tags": [
    "string"
  ],
  "vrf_context_ids": [
    "string"
  ],
  "vrf_context_route_leak_rules": [
    {
      "dest_vrf_context_id": "string",
      "ipv4_prefixes": [
        "string"
      ],
      "name": "string",
      "src_vrf_context_id": "string"
    }
  ]
}

400

Bad Request

application/json

Schema

Schema

_error ErrorResponse[]
Array [
code string
The error code.
message string
The error message.
]

Example (from schema)

{
  "_error": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

Example

{
  "value": {
    "_error": [
      {
        "code": "VRF_CONTEXT_PROFILE_NAME_INVALID"
      },
      {
        "code": "VRF_CONTEXT_PROFILE_NAME_EXCEEDS_LIMIT"
      },
      {
        "code": "VRF_CONTEXT_PROFILE_DESCRIPTION_INVALID"
      },
      {
        "code": "VRF_CONTEXT_ROUTE_LEAK_RULE_NAME_INVALID"
      },
      {
        "code": "VRF_CONTEXT_ROUTE_LEAK_RULE_NAME_EXCEEDS_LIMIT"
      },
      {
        "code": "VRF_CONTEXT_ROUTE_LEAK_RULE_DESCRIPTION_INVALID"
      },
      {
        "code": "SOURCE_VRF_CONTEXT_INVALID"
      },
      {
        "code": "DESTINATION_VRF_CONTEXT_INVALID"
      },
      {
        "code": "INVALID_PREFIX"
      },
      {
        "code": "INVALID_JSON_EXTRA_ATTRIBUTE"
      }
    ]
  }
}

Loading...