Skip to content

telstra/Programmable-Network-SDK-dotnet

BranchesTags

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
docs
docs
 
 
src/main/CsharpDotNet2/IO/TelstraTPN
src/main/CsharpDotNet2/IO/TelstraTPN
 
 
vendor
vendor
 
 
LICENSE
LICENSE
 
 
README.md
README.md
 
 
compile-mono.sh
compile-mono.sh
 
 

Repository files navigation

Telstra Programmable Network

Telstra Programmable Network is a self-provisioning platform that allows its users to create on-demand connectivity services between multiple end-points and add various network functions to those services. Programmable Network enables to connectivity to a global ecosystem of networking services as well as public and private cloud services. Once you are connected to the platform on one or more POPs (points of presence), you can start creating those services based on the use case that you want to accomplish. The Programmable Network API is available to all customers who have registered to use the Programmable Network. To register, please contact your account representative.

  • API version: 2.1.3
  • SDK version: 1.0.0
  • Build date: 2018-01-17T21:50:14.739+11:00

Frameworks supported

  • .NET 2.0

Dependencies

  • Mono compiler
  • Newtonsoft.Json.7.0.1
  • RestSharp.Net2.1.1.11

Note: NuGet is downloaded by the mono compilation script and packages are installed with it. No dependency DLLs are bundled with this generator

Installation

Run the following command to generate the DLL

  • [Mac/Linux] /bin/sh compile-mono.sh
  • [Windows] TODO

Then include the DLL (under the bin folder) in the C# project, and use the namespaces:

using IO.TelstraTPN.Api;
using IO.TelstraTPN;
using IO.TelstraTPN.Model;

Getting Started

using System;
using System.Diagnostics;
using IO.TelstraTPN.Api;
using IO.TelstraTPN;
using IO.TelstraTPN.Model;

namespace Example
{
    public class Example
    {
        public void main()
        {
            
            var apiInstance = new AuthenticationApi();
            var grantType = grantType_example;  // string | 
            var username = username_example;  // string | 
            var password = password_example;  // string | 

            try
            {
                // Create an authentication token
                AuthGeneratetokenResponse result = apiInstance.AuthGeneratetokenPost(grantType, username, password);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AuthenticationApi.AuthGeneratetokenPost: " + e.Message );
            }
        }
    }
}

Documentation for API Endpoints

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

Class Method HTTP request Description
AuthenticationApi AuthGeneratetokenPost POST /1.0.0/auth/generatetoken Create an authentication token
AuthenticationApi AuthValidatetokenGet GET /1.0.0/auth/validatetoken Validate authentication token
ContractsApi InventoryLinksContractByLinkidAndContractidGet GET /1.0.0/inventory/links/{linkid}/contract/{contractid} Get active Contract by ContractID
ContractsApi InventoryLinksContractByLinkidAndContractidPut PUT /1.0.0/inventory/links/{linkid}/contract/{contractid} Update active Contract by ContractID
ContractsApi InventoryLinksContractByLinkidPost POST /1.0.0/inventory/links/{linkid}/contract Create new Contract on specified link
CustomersApi AccountByCustomeruuidGet GET /1.0.0/account/{customeruuid} Get account information details
CustomersApi AccountUserByCustomeruuidGet GET /1.0.0/account/{customeruuid}/user List users
DatacentresApi InventoryDatacentersGet GET /1.0.0/inventory/datacenters Get list of all the data centers
EndpointsApi Eis100EndpointsAssignTopologyTagByEndpointuuidPost POST /eis/1.0.0/endpoints/{endpointuuid}/assign_topology_tag Assign a Topology Tag to an Endpoint
EndpointsApi InventoryEndpointByEndpointuuidGet GET /1.0.0/inventory/endpoint/{endpointuuid} Get information about the specified endpoint
EndpointsApi InventoryEndpointsCustomeruuidByCustomeruuidGet GET /1.0.0/inventory/endpoints/customeruuid/{customeruuid} Get list of endpoints for a customer
EndpointsApi InventoryRegularendpointPost POST /1.0.0/inventory/regularendpoint Create Physical (Port) Endpoint
EndpointsApi InventoryVnfendpointPost POST /1.0.0/inventory/vnfendpoint Create VNF Endpoint
LinksApi InventoryLinkPost POST /1.0.0/inventory/link Create Link and initial Contract
LinksApi InventoryLinksByLinkidGet GET /1.0.0/inventory/links/{linkid} Get details of specified link
LinksApi InventoryLinksCustomerByCustomeruuidGet GET /1.0.0/inventory/links/customer/{customeruuid} Get active Links
LinksApi InventoryLinksHistoryByLinkidGet GET /1.0.0/inventory/links/history/{linkid} Get Link history
TopologiesApi Ttms100TopologyTagByTopotaguuidDelete DELETE /ttms/1.0.0/topology_tag/{topotaguuid}/ Delete a topology tag
TopologiesApi Ttms100TopologyTagByTopotaguuidGet GET /ttms/1.0.0/topology_tag/{topotaguuid}/ Get information about the specified topology tag
TopologiesApi Ttms100TopologyTagByTopotaguuidPut PUT /ttms/1.0.0/topology_tag/{topotaguuid}/ Update a topology tag's name and/or description
TopologiesApi Ttms100TopologyTagGet GET /ttms/1.0.0/topology_tag List all topology tags
TopologiesApi Ttms100TopologyTagObjectsByTopotaguuidGet GET /ttms/1.0.0/topology_tag/{topotaguuid}/objects/ List objects for Topology
TopologiesApi Ttms100TopologyTagPost POST /ttms/1.0.0/topology_tag Create a named topology tag
VnfsApi MarketplaceImageGet GET /1.0.0/marketplace/image List images in the Marketplace
VportsApi InventoryRegularvportPost POST /1.0.0/inventory/regularvport Create VPort for physical endpoint
VportsApi InventoryVnfVportPost POST /1.0.0/inventory/vnf/vport Create VNF VPort
VportsApi InventoryVportByVportuuidGet GET /1.0.0/inventory/vport/{vportuuid} Get information about the specified VPort

Documentation for Models

Documentation for Authorization

auth

  • Type: OAuth
  • Flow: password
  • Authorization URL:
  • Scopes:
    • Oauth2: Oauth2

About

Telstra Programmable Network SDK - .Net2 Library

dev.telstra.com

Topics

sdk dotnet-core2 telstradev programmable-network

Resources

Readme

License

Apache-2.0 license
Activity
Custom properties

Stars

1 star

Watchers

8 watching

Forks

0 forks
Report repository

Releases

No releases published

Packages

No packages published

Languages