Skip to content

Latest commit

 

History

History
163 lines (110 loc) · 4.56 KB

VportsApi.md

File metadata and controls

163 lines (110 loc) · 4.56 KB

TelstraTPN::VportsApi

Load the API package

use TelstraTPN::Object::VportsApi;

All URIs are relative to https://penapi.pacnetconnect.com

Method HTTP request Description
inventory_regularvport_post POST /1.0.0/inventory/regularvport Create VPort for physical endpoint
inventory_vnf_vport_post POST /1.0.0/inventory/vnf/vport Create VNF VPort
inventory_vport_by_vportuuid_get GET /1.0.0/inventory/vport/{vportuuid} Get information about the specified VPort

inventory_regularvport_post

InventoryRegularvportResponse inventory_regularvport_post(body => $body)

Create VPort for physical endpoint

Create VPort representing a VLAN on a Physical Ethernet Port

Example

use Data::Dumper;
use TelstraTPN::VportsApi;
my $api_instance = TelstraTPN::VportsApi->new(

    # Configure OAuth2 access token for authorization: auth
    access_token => 'YOUR_ACCESS_TOKEN',
);

my $body = TelstraTPN::Object::InventoryRegularvportRequest->new(); # InventoryRegularvportRequest | 

eval { 
    my $result = $api_instance->inventory_regularvport_post(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VportsApi->inventory_regularvport_post: $@\n";
}

Parameters

Name Type Description Notes
body InventoryRegularvportRequest [optional]

Return type

InventoryRegularvportResponse

Authorization

auth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

inventory_vnf_vport_post

InventoryVnfVportResponse inventory_vnf_vport_post(body => $body)

Create VNF VPort

Create VNF VPort

Example

use Data::Dumper;
use TelstraTPN::VportsApi;
my $api_instance = TelstraTPN::VportsApi->new(

    # Configure OAuth2 access token for authorization: auth
    access_token => 'YOUR_ACCESS_TOKEN',
);

my $body = TelstraTPN::Object::InventoryVnfVportRequest->new(); # InventoryVnfVportRequest | 

eval { 
    my $result = $api_instance->inventory_vnf_vport_post(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VportsApi->inventory_vnf_vport_post: $@\n";
}

Parameters

Name Type Description Notes
body InventoryVnfVportRequest [optional]

Return type

InventoryVnfVportResponse

Authorization

auth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

inventory_vport_by_vportuuid_get

ARRAY[EndpointPort] inventory_vport_by_vportuuid_get(vportuuid => $vportuuid)

Get information about the specified VPort

Get information about the specified VPort

Example

use Data::Dumper;
use TelstraTPN::VportsApi;
my $api_instance = TelstraTPN::VportsApi->new(

    # Configure OAuth2 access token for authorization: auth
    access_token => 'YOUR_ACCESS_TOKEN',
);

my $vportuuid = 'vportuuid_example'; # string | Unique identifier representing a specific virtual port

eval { 
    my $result = $api_instance->inventory_vport_by_vportuuid_get(vportuuid => $vportuuid);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VportsApi->inventory_vport_by_vportuuid_get: $@\n";
}

Parameters

Name Type Description Notes
vportuuid string Unique identifier representing a specific virtual port

Return type

ARRAY[EndpointPort]

Authorization

auth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]