Chilkat Tools

DescribeVirtualInterfaces Powershell Example

AWS Direct Connect

Add-Type -Path "C:\chilkat\ChilkatDotNet47-9.5.0-x64\ChilkatDotNet47.dll"

# This example requires the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

$rest = New-Object Chilkat.Rest

$authAws = New-Object Chilkat.AuthAws
$authAws.AccessKey = "AWS_ACCESS_KEY"
$authAws.SecretKey = "AWS_SECRET_KEY"

# Don't forget to change the region to your particular region. (Also make the same change in the call to Connect below.)
$authAws.Region = "us-west-2"
$authAws.ServiceName = "directconnect"
# SetAuthAws causes Chilkat to automatically add the following headers: Authorization, X-Amz-Date
$rest.SetAuthAws($authAws)

# URL: https://directconnect.us-west-2.amazonaws.com/
# Use the same region as specified above.
$success = $rest.Connect("directconnect.us-west-2.amazonaws.com",443,$true,$true)
if ($success -ne $true) {
    $("ConnectFailReason: " + $rest.ConnectFailReason)
    $($rest.LastErrorText)
    exit
}

# The following code creates the JSON request body.
# The JSON created by this code is shown below.

# Use this online tool to generate code from sample JSON:
# Generate Code to Create JSON

$json = New-Object Chilkat.JsonObject
$json.UpdateString("connectionId","string")
$json.UpdateString("virtualInterfaceId","string")

# The JSON request body created by the above code:

# {
#   "connectionId": "string",
#   "virtualInterfaceId": "string"
# }

$rest.AddHeader("Content-Type","application/x-amz-json-1.1")
$rest.AddHeader("X-Amz-Target","OvertureService.DescribeVirtualInterfaces")

$sbRequestBody = New-Object Chilkat.StringBuilder
$json.EmitSb($sbRequestBody)
$sbResponseBody = New-Object Chilkat.StringBuilder
$success = $rest.FullRequestSb("POST","/",$sbRequestBody,$sbResponseBody)
if ($success -ne $true) {
    $($rest.LastErrorText)
    exit
}

$respStatusCode = $rest.ResponseStatusCode
$("response status code = " + $respStatusCode)
if ($respStatusCode -ne 200) {
    $("Response Header:")
    $($rest.ResponseHeader)
    $("Response Body:")
    $($sbResponseBody.GetAsString())
    exit
}

$jResp = New-Object Chilkat.JsonObject
$jResp.LoadSb($sbResponseBody)

# The following code parses the JSON response.
# A sample JSON response is shown below the sample code.

# Use this online tool to generate parsing code from sample JSON:
# Generate Parsing Code from JSON

$i = 0
$count_i = $jResp.SizeOfArray("virtualInterfaces")
while ($i -lt $count_i) {
    $jResp.I = $i
    $addressFamily = $jResp.StringOf("virtualInterfaces[i].addressFamily")
    $amazonAddress = $jResp.StringOf("virtualInterfaces[i].amazonAddress")
    $amazonSideAsn = $jResp.IntOf("virtualInterfaces[i].amazonSideAsn")
    $asn = $jResp.IntOf("virtualInterfaces[i].asn")
    $authKey = $jResp.StringOf("virtualInterfaces[i].authKey")
    $awsDeviceV2 = $jResp.StringOf("virtualInterfaces[i].awsDeviceV2")
    $awsLogicalDeviceId = $jResp.StringOf("virtualInterfaces[i].awsLogicalDeviceId")
    $connectionId = $jResp.StringOf("virtualInterfaces[i].connectionId")
    $customerAddress = $jResp.StringOf("virtualInterfaces[i].customerAddress")
    $customerRouterConfig = $jResp.StringOf("virtualInterfaces[i].customerRouterConfig")
    $directConnectGatewayId = $jResp.StringOf("virtualInterfaces[i].directConnectGatewayId")
    $jumboFrameCapable = $jResp.IntOf("virtualInterfaces[i].jumboFrameCapable")
    $location = $jResp.StringOf("virtualInterfaces[i].location")
    $mtu = $jResp.IntOf("virtualInterfaces[i].mtu")
    $ownerAccount = $jResp.StringOf("virtualInterfaces[i].ownerAccount")
    $region = $jResp.StringOf("virtualInterfaces[i].region")
    $siteLinkEnabled = $jResp.IntOf("virtualInterfaces[i].siteLinkEnabled")
    $virtualGatewayId = $jResp.StringOf("virtualInterfaces[i].virtualGatewayId")
    $virtualInterfaceId = $jResp.StringOf("virtualInterfaces[i].virtualInterfaceId")
    $virtualInterfaceName = $jResp.StringOf("virtualInterfaces[i].virtualInterfaceName")
    $virtualInterfaceState = $jResp.StringOf("virtualInterfaces[i].virtualInterfaceState")
    $virtualInterfaceType = $jResp.StringOf("virtualInterfaces[i].virtualInterfaceType")
    $vlan = $jResp.IntOf("virtualInterfaces[i].vlan")
    $j = 0
    $count_j = $jResp.SizeOfArray("virtualInterfaces[i].bgpPeers")
    while ($j -lt $count_j) {
        $jResp.J = $j
        $addressFamily = $jResp.StringOf("virtualInterfaces[i].bgpPeers[j].addressFamily")
        $amazonAddress = $jResp.StringOf("virtualInterfaces[i].bgpPeers[j].amazonAddress")
        $asn = $jResp.IntOf("virtualInterfaces[i].bgpPeers[j].asn")
        $authKey = $jResp.StringOf("virtualInterfaces[i].bgpPeers[j].authKey")
        $awsDeviceV2 = $jResp.StringOf("virtualInterfaces[i].bgpPeers[j].awsDeviceV2")
        $awsLogicalDeviceId = $jResp.StringOf("virtualInterfaces[i].bgpPeers[j].awsLogicalDeviceId")
        $bgpPeerId = $jResp.StringOf("virtualInterfaces[i].bgpPeers[j].bgpPeerId")
        $bgpPeerState = $jResp.StringOf("virtualInterfaces[i].bgpPeers[j].bgpPeerState")
        $bgpStatus = $jResp.StringOf("virtualInterfaces[i].bgpPeers[j].bgpStatus")
        $customerAddress = $jResp.StringOf("virtualInterfaces[i].bgpPeers[j].customerAddress")
        $j = $j + 1
    }

    $j = 0
    $count_j = $jResp.SizeOfArray("virtualInterfaces[i].routeFilterPrefixes")
    while ($j -lt $count_j) {
        $jResp.J = $j
        $cidr = $jResp.StringOf("virtualInterfaces[i].routeFilterPrefixes[j].cidr")
        $j = $j + 1
    }

    $j = 0
    $count_j = $jResp.SizeOfArray("virtualInterfaces[i].tags")
    while ($j -lt $count_j) {
        $jResp.J = $j
        $key = $jResp.StringOf("virtualInterfaces[i].tags[j].key")
        $value = $jResp.StringOf("virtualInterfaces[i].tags[j].value")
        $j = $j + 1
    }

    $i = $i + 1
}

# A sample JSON response body parsed by the above code:

# {
#   "virtualInterfaces": [
#     {
#       "addressFamily": "string",
#       "amazonAddress": "string",
#       "amazonSideAsn": number,
#       "asn": number,
#       "authKey": "string",
#       "awsDeviceV2": "string",
#       "awsLogicalDeviceId": "string",
#       "bgpPeers": [
#         {
#           "addressFamily": "string",
#           "amazonAddress": "string",
#           "asn": number,
#           "authKey": "string",
#           "awsDeviceV2": "string",
#           "awsLogicalDeviceId": "string",
#           "bgpPeerId": "string",
#           "bgpPeerState": "string",
#           "bgpStatus": "string",
#           "customerAddress": "string"
#         }
#       ],
#       "connectionId": "string",
#       "customerAddress": "string",
#       "customerRouterConfig": "string",
#       "directConnectGatewayId": "string",
#       "jumboFrameCapable": boolean,
#       "location": "string",
#       "mtu": number,
#       "ownerAccount": "string",
#       "region": "string",
#       "routeFilterPrefixes": [
#         {
#           "cidr": "string"
#         }
#       ],
#       "siteLinkEnabled": boolean,
#       "tags": [
#         {
#           "key": "string",
#           "value": "string"
#         }
#       ],
#       "virtualGatewayId": "string",
#       "virtualInterfaceId": "string",
#       "virtualInterfaceName": "string",
#       "virtualInterfaceState": "string",
#       "virtualInterfaceType": "string",
#       "vlan": number
#     }
#   ]
# }
Chilkat Online Tools

DescribeVirtualInterfaces Powershell Example

AWS Direct Connect
