Chilkat Online Tools

DescribeStorageVirtualMachines TCL Example

Amazon FSx

load ./chilkat.dll

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

set rest [new_CkRest]

set authAws [new_CkAuthAws]

CkAuthAws_put_AccessKey $authAws "AWS_ACCESS_KEY"
CkAuthAws_put_SecretKey $authAws "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.)
CkAuthAws_put_Region $authAws "us-west-2"
CkAuthAws_put_ServiceName $authAws "fsx"
# SetAuthAws causes Chilkat to automatically add the following headers: Authorization, X-Amz-Date
CkRest_SetAuthAws $rest $authAws

# URL: https://fsx.us-west-2.amazonaws.com/
# Use the same region as specified above.
set success [CkRest_Connect $rest "fsx.us-west-2.amazonaws.com" 443 1 1]
if {$success != 1} then {
    puts "ConnectFailReason: [CkRest_get_ConnectFailReason $rest]"
    puts [CkRest_lastErrorText $rest]
    delete_CkRest $rest
    delete_CkAuthAws $authAws
    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

set json [new_CkJsonObject]

CkJsonObject_UpdateString $json "Filters[0].Name" "string"
CkJsonObject_UpdateString $json "Filters[0].Values[0]" "string"
CkJsonObject_UpdateInt $json "MaxResults" 123
CkJsonObject_UpdateString $json "NextToken" "string"
CkJsonObject_UpdateString $json "StorageVirtualMachineIds[0]" "string"

# The JSON request body created by the above code:

# {
#   "Filters": [
#     {
#       "Name": "string",
#       "Values": [
#         "string"
#       ]
#     }
#   ],
#   "MaxResults": number,
#   "NextToken": "string",
#   "StorageVirtualMachineIds": [
#     "string"
#   ]
# }

CkRest_AddHeader $rest "Content-Type" "application/x-amz-json-1.1"
CkRest_AddHeader $rest "X-Amz-Target" "AWSSimbaAPIService_v20180301.DescribeStorageVirtualMachines"

set sbRequestBody [new_CkStringBuilder]

CkJsonObject_EmitSb $json $sbRequestBody
set sbResponseBody [new_CkStringBuilder]

set success [CkRest_FullRequestSb $rest "POST" "/" $sbRequestBody $sbResponseBody]
if {$success != 1} then {
    puts [CkRest_lastErrorText $rest]
    delete_CkRest $rest
    delete_CkAuthAws $authAws
    delete_CkJsonObject $json
    delete_CkStringBuilder $sbRequestBody
    delete_CkStringBuilder $sbResponseBody
    exit
}

set respStatusCode [CkRest_get_ResponseStatusCode $rest]
puts "response status code = $respStatusCode"
if {$respStatusCode != 200} then {
    puts "Response Header:"
    puts [CkRest_responseHeader $rest]
    puts "Response Body:"
    puts [CkStringBuilder_getAsString $sbResponseBody]
    delete_CkRest $rest
    delete_CkAuthAws $authAws
    delete_CkJsonObject $json
    delete_CkStringBuilder $sbRequestBody
    delete_CkStringBuilder $sbResponseBody
    exit
}

set jResp [new_CkJsonObject]

CkJsonObject_LoadSb $jResp $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

set NextToken [CkJsonObject_stringOf $jResp "NextToken"]
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "StorageVirtualMachines"]
while {$i < $count_i} {
    CkJsonObject_put_I $jResp $i
    set NetBiosName [CkJsonObject_stringOf $jResp "StorageVirtualMachines[i].ActiveDirectoryConfiguration.NetBiosName"]
    set DomainName [CkJsonObject_stringOf $jResp "StorageVirtualMachines[i].ActiveDirectoryConfiguration.SelfManagedActiveDirectoryConfiguration.DomainName"]
    set FileSystemAdministratorsGroup [CkJsonObject_stringOf $jResp "StorageVirtualMachines[i].ActiveDirectoryConfiguration.SelfManagedActiveDirectoryConfiguration.FileSystemAdministratorsGroup"]
    set OrganizationalUnitDistinguishedName [CkJsonObject_stringOf $jResp "StorageVirtualMachines[i].ActiveDirectoryConfiguration.SelfManagedActiveDirectoryConfiguration.OrganizationalUnitDistinguishedName"]
    set UserName [CkJsonObject_stringOf $jResp "StorageVirtualMachines[i].ActiveDirectoryConfiguration.SelfManagedActiveDirectoryConfiguration.UserName"]
    set CreationTime [CkJsonObject_IntOf $jResp "StorageVirtualMachines[i].CreationTime"]
    set DNSName [CkJsonObject_stringOf $jResp "StorageVirtualMachines[i].Endpoints.Iscsi.DNSName"]
    set ManagementDNSName [CkJsonObject_stringOf $jResp "StorageVirtualMachines[i].Endpoints.Management.DNSName"]
    set NfsDNSName [CkJsonObject_stringOf $jResp "StorageVirtualMachines[i].Endpoints.Nfs.DNSName"]
    set SmbDNSName [CkJsonObject_stringOf $jResp "StorageVirtualMachines[i].Endpoints.Smb.DNSName"]
    set FileSystemId [CkJsonObject_stringOf $jResp "StorageVirtualMachines[i].FileSystemId"]
    set Lifecycle [CkJsonObject_stringOf $jResp "StorageVirtualMachines[i].Lifecycle"]
    set Message [CkJsonObject_stringOf $jResp "StorageVirtualMachines[i].LifecycleTransitionReason.Message"]
    set Name [CkJsonObject_stringOf $jResp "StorageVirtualMachines[i].Name"]
    set ResourceARN [CkJsonObject_stringOf $jResp "StorageVirtualMachines[i].ResourceARN"]
    set RootVolumeSecurityStyle [CkJsonObject_stringOf $jResp "StorageVirtualMachines[i].RootVolumeSecurityStyle"]
    set StorageVirtualMachineId [CkJsonObject_stringOf $jResp "StorageVirtualMachines[i].StorageVirtualMachineId"]
    set Subtype [CkJsonObject_stringOf $jResp "StorageVirtualMachines[i].Subtype"]
    set UUID [CkJsonObject_stringOf $jResp "StorageVirtualMachines[i].UUID"]
    set j 0
    set count_j [CkJsonObject_SizeOfArray $jResp "StorageVirtualMachines[i].ActiveDirectoryConfiguration.SelfManagedActiveDirectoryConfiguration.DnsIps"]
    while {$j < $count_j} {
        CkJsonObject_put_J $jResp $j
        set strVal [CkJsonObject_stringOf $jResp "StorageVirtualMachines[i].ActiveDirectoryConfiguration.SelfManagedActiveDirectoryConfiguration.DnsIps[j]"]
        set j [expr $j + 1]
    }
    set j 0
    set count_j [CkJsonObject_SizeOfArray $jResp "StorageVirtualMachines[i].Endpoints.Iscsi.IpAddresses"]
    while {$j < $count_j} {
        CkJsonObject_put_J $jResp $j
        set strVal [CkJsonObject_stringOf $jResp "StorageVirtualMachines[i].Endpoints.Iscsi.IpAddresses[j]"]
        set j [expr $j + 1]
    }
    set j 0
    set count_j [CkJsonObject_SizeOfArray $jResp "StorageVirtualMachines[i].Endpoints.Management.IpAddresses"]
    while {$j < $count_j} {
        CkJsonObject_put_J $jResp $j
        set strVal [CkJsonObject_stringOf $jResp "StorageVirtualMachines[i].Endpoints.Management.IpAddresses[j]"]
        set j [expr $j + 1]
    }
    set j 0
    set count_j [CkJsonObject_SizeOfArray $jResp "StorageVirtualMachines[i].Endpoints.Nfs.IpAddresses"]
    while {$j < $count_j} {
        CkJsonObject_put_J $jResp $j
        set strVal [CkJsonObject_stringOf $jResp "StorageVirtualMachines[i].Endpoints.Nfs.IpAddresses[j]"]
        set j [expr $j + 1]
    }
    set j 0
    set count_j [CkJsonObject_SizeOfArray $jResp "StorageVirtualMachines[i].Endpoints.Smb.IpAddresses"]
    while {$j < $count_j} {
        CkJsonObject_put_J $jResp $j
        set strVal [CkJsonObject_stringOf $jResp "StorageVirtualMachines[i].Endpoints.Smb.IpAddresses[j]"]
        set j [expr $j + 1]
    }
    set j 0
    set count_j [CkJsonObject_SizeOfArray $jResp "StorageVirtualMachines[i].Tags"]
    while {$j < $count_j} {
        CkJsonObject_put_J $jResp $j
        set Key [CkJsonObject_stringOf $jResp "StorageVirtualMachines[i].Tags[j].Key"]
        set Value [CkJsonObject_stringOf $jResp "StorageVirtualMachines[i].Tags[j].Value"]
        set j [expr $j + 1]
    }
    set i [expr $i + 1]
}

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

# {
#   "NextToken": "string",
#   "StorageVirtualMachines": [
#     {
#       "ActiveDirectoryConfiguration": {
#         "NetBiosName": "string",
#         "SelfManagedActiveDirectoryConfiguration": {
#           "DnsIps": [
#             "string"
#           ],
#           "DomainName": "string",
#           "FileSystemAdministratorsGroup": "string",
#           "OrganizationalUnitDistinguishedName": "string",
#           "UserName": "string"
#         }
#       },
#       "CreationTime": number,
#       "Endpoints": {
#         "Iscsi": {
#           "DNSName": "string",
#           "IpAddresses": [
#             "string"
#           ]
#         },
#         "Management": {
#           "DNSName": "string",
#           "IpAddresses": [
#             "string"
#           ]
#         },
#         "Nfs": {
#           "DNSName": "string",
#           "IpAddresses": [
#             "string"
#           ]
#         },
#         "Smb": {
#           "DNSName": "string",
#           "IpAddresses": [
#             "string"
#           ]
#         }
#       },
#       "FileSystemId": "string",
#       "Lifecycle": "string",
#       "LifecycleTransitionReason": {
#         "Message": "string"
#       },
#       "Name": "string",
#       "ResourceARN": "string",
#       "RootVolumeSecurityStyle": "string",
#       "StorageVirtualMachineId": "string",
#       "Subtype": "string",
#       "Tags": [
#         {
#           "Key": "string",
#           "Value": "string"
#         }
#       ],
#       "UUID": "string"
#     }
#   ]
# }

delete_CkRest $rest
delete_CkAuthAws $authAws
delete_CkJsonObject $json
delete_CkStringBuilder $sbRequestBody
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp