Skip to main content

Get a virtual network by its identifier

GET 
/projects/:projectId/zones/:zoneName/virtualnetworks/:virtualNetworkId

Return Virtual Network resource with its identifier (in the path).

Request​

Path Parameters

    projectId stringrequired

    Project Identifier

    zoneName stringrequired

    Zone name

    virtualNetworkId stringrequired

    Virtual network Identifier

Header Parameters

    X-API-Key string

    Your SIU token if you use this API through Orange Developer.

    Authorization string

    Bearer access token authentication if you use this API through Orange Developer or Orange Developer Inside.

    X-Requester-Id string

    Your SIU Id if you use this API through Orange Developer Inside.

Responses​

Ok

Schema

    id stringrequired

    Id of the Virtual Network.

    hRef stringrequired

    HREF of the Virtual Network.

    name stringrequired

    Possible values: <= 40 characters, Value must match regular expression [A-Za-z0-9-]

    Name of the Virtual Network. Must be unique within the project for a zone. Cannot be updated.

    description string

    Description of the Virtual Network

    tags

    object

    Tags associated with the virtual network.

    property name* string
    createdDate string

    Date when the Virtual Network was created.

    lastModifiedDate string

    Date when the Virtual Network was last modified.

    lastRequester string

    User name (CUID or SIUID) associated with the last modification request (creation, update or deletion).

    provisioningState BasicStateEnum (string)

    Possible values: [creating, updating, deleting, active, error]

    Provisioning state of the resource. Possible state:

    • creating: resource creation in progress
    • updating: resource update in progress
    • deleting: resource deletion in progress
    • active: resource created/updated successfully
    • error: resource in error because the last creation/update/deletion failed

    vpns

    object[]

    Possible values: <= 99

    List of VPNs attached to the VN. Impact if VPN are modified or removed.

  • Array [

    • vpnName stringrequired

    VPN name. This attribute can not be updated.

    vnRole VPNRoleEnum (string)required

    Possible values: [any-to-any, client, server]

    VN role in the VPN.

  • ]

    • subnets

    object[]

    required

    List of subnets. It is not possible to remove a subnet from this list once an IP has been allocated from this subnet.

  • Array [

    • subnet stringrequired

    Subnet in CIDR format. Cannot be updated. IPv6 not available yet.

    enableDhcp boolean

    Default value: true

    Enable DHCP on subnet. This attribute can not be updated.

    allocateIpAddressFromStart boolean

    Default value: true

    Subnet IP allocation rule for DHCP process:

    • true: from first address of subnet
    • false: from last address of subnet
    dnsPrimary string

    IP address of the primary DNS server (applicable to IPV4 subnets only).

    dnsSecondary string

    IP address of the secondary DNS server (applicable to IPV4 subnets only).

    allocationPools

    object[]

    List of pools of IP addresses belonging to the subnet that can be used by DHCP allocation process. If not defined, the entire subnet is used. After addition of the subnet, it is only possible to add pools.

  • Array [

    • start stringrequired

    First IP address of the pool.

    end stringrequired

    Last IP address of the pool.

  • ]

    • hostRoutes

    object[]

    Host routes, configured for the subnet, that are sent to the VM by DHCP. Changes are not taken into account until a new DHCP request is sent. NB: this option is usually used in combination with IRT (Interface Route Table) or NRT (Network Route Table).

  • Array [

    • prefix stringrequired

    Prefix of the route in CIDR format. This attribute can not be updated.

    nextHop stringrequired

    Next hop IP address of the route. This attribute can not be updated.

  • ]

    • gatewayIpAddress string

    IP address of the Contrail vRouter to be used for its "gateway" role. If not defined, Contrail uses the first usable address of the subnet (from start or from end depending on the value of the parameter allocateIpAddressFromStart). This attribute can not be updated. Ipv6 not available yet.

    serviceIpAddress string

    IP address that the vRouter must use to configure its service interface on this VN. If not defined, Contrail uses the second usable address of the subnet (from start or from end depending on the value of the parameter allocateIpAddressFromStart). Ipv6 not available yet.

  • ]

    • hostRoutes

    object[]

    Host routes, configured for the subnet, that are sent to the VM by DHCP. Changes are not taken into account until a new DHCP request is sent. NB: this option is usually used in combination with IRT (Interface Route Table) or NRT (Network Route Table).

  • Array [

    • prefix stringrequired

    Prefix of the route in CIDR format. This attribute can not be updated.

    nextHop stringrequired

    Next hop IP address of the route. This attribute can not be updated.

  • ]

    • networkRoutes object[]

    Network routes that are pushed on the vrouter. In a general case, this option is used in combination with host routes. NB: impact service if routes are removed.

    routingPolicyRefs

    object[]

    List of routing policies applied on the VN, identified either by their name or their resource id. NB: the order in the list is the order in which the routing policies will be applied.

  • Array [

    • id uuid

    Identifier of the referred resource. If not provided, either name or hRef must be filled. This parameter can not be updated.

    name string

    Possible values: non-empty and <= 40 characters

    Name of the referred resource. If not provided, either hRef or identifier must be filled. This parameter can not be updated.

    hRef uri

    hRef of the referred resource. If not provided, either name or identifier must be filled. This parameter can not be updated.

  • ]

Loading...