Cisco Packet Tracer Northbound API for Network Controller Device

Tickets API

addTicket

This method is used to create a new user ticket

/ticket

Usage and SDK Samples

Curl

curl -X POST "http://{IP}:{PORT}/api/v1/ticket"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TicketApi;

import java.io.File;
import java.util.*;

public class TicketApiExample {

    public static void main(String[] args) {
        
        TicketApi apiInstance = new TicketApi();
        Ticket_User user = ; // Ticket_User | user
        try {
            Ticket_TicketResult result = apiInstance.addTicket(user);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TicketApi#addTicket");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.TicketApi;

public class TicketApiExample {

    public static void main(String[] args) {
        TicketApi apiInstance = new TicketApi();
        Ticket_User user = ; // Ticket_User | user
        try {
            Ticket_TicketResult result = apiInstance.addTicket(user);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TicketApi#addTicket");
            e.printStackTrace();
        }
    }
}

Ticket_User *user = ; // user (optional)

TicketApi *apiInstance = [[TicketApi alloc] init];

// addTicket
[apiInstance addTicketWith:user
              completionHandler: ^(Ticket_TicketResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var CiscoPacketTracerNorthboundApiForNetworkControllerDevice = require('cisco_packet_tracer_northbound_api_for_network_controller_device');

var api = new CiscoPacketTracerNorthboundApiForNetworkControllerDevice.TicketApi()

var opts = { 
  'user':  // {Ticket_User} user
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.addTicket(opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class addTicketExample
    {
        public void main()
        {
            
            var apiInstance = new TicketApi();
            var user = new Ticket_User(); // Ticket_User | user (optional) 

            try
            {
                // addTicket
                Ticket_TicketResult result = apiInstance.addTicket(user);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TicketApi.addTicket: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\TicketApi();
$user = ; // Ticket_User | user

try {
    $result = $api_instance->addTicket($user);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TicketApi->addTicket: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TicketApi;

my $api_instance = WWW::SwaggerClient::TicketApi->new();
my $user = WWW::SwaggerClient::Object::Ticket_User->new(); # Ticket_User | user

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

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.TicketApi()
user =  # Ticket_User | user (optional)


try: 
    # addTicket
    api_response = api_instance.add_ticket(user=user)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TicketApi->addTicket: %s\n" % e)

Parameters

Body parameters

Name	Description
user

Responses

Status: 200 - success

Schema

Status: 201 - The POST request was fulfilled and a new resource has been created. Information about the resource is in the response body.

Status: 400 - The client made a request that the server could not understand (for example, the request syntax is incorrect).

Status: 401 - Not Authorized Yet, Credentials to be supplied

Status: 500 - The server could not fulfill the request.

Status: 501 - The server has not implemented the functionality required to fulfill the request.

deleteTicket

Revoke ticket, effectively sign out

/ticket/{ticket}

Usage and SDK Samples

Curl

curl -X DELETE -H "X-Auth-Token: [[apiKey]]" "http://{IP}:{PORT}/api/v1/ticket/{ticket}"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TicketApi;

import java.io.File;
import java.util.*;

public class TicketApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: auth_ticket
        ApiKeyAuth auth_ticket = (ApiKeyAuth) defaultClient.getAuthentication("auth_ticket");
        auth_ticket.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //auth_ticket.setApiKeyPrefix("Token");

        TicketApi apiInstance = new TicketApi();
        String ticket = ticket_example; // String | ticket
        try {
            Common_BooleanResponse result = apiInstance.deleteTicket(ticket);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TicketApi#deleteTicket");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.TicketApi;

public class TicketApiExample {

    public static void main(String[] args) {
        TicketApi apiInstance = new TicketApi();
        String ticket = ticket_example; // String | ticket
        try {
            Common_BooleanResponse result = apiInstance.deleteTicket(ticket);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TicketApi#deleteTicket");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: auth_ticket)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Auth-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Auth-Token"];

String *ticket = ticket_example; // ticket

TicketApi *apiInstance = [[TicketApi alloc] init];

// deleteTicket
[apiInstance deleteTicketWith:ticket
              completionHandler: ^(Common_BooleanResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var CiscoPacketTracerNorthboundApiForNetworkControllerDevice = require('cisco_packet_tracer_northbound_api_for_network_controller_device');
var defaultClient = CiscoPacketTracerNorthboundApiForNetworkControllerDevice.ApiClient.instance;

// Configure API key authorization: auth_ticket
var auth_ticket = defaultClient.authentications['auth_ticket'];
auth_ticket.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//auth_ticket.apiKeyPrefix['X-Auth-Token'] = "Token"

var api = new CiscoPacketTracerNorthboundApiForNetworkControllerDevice.TicketApi()

var ticket = ticket_example; // {String} ticket


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteTicket(ticket, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteTicketExample
    {
        public void main()
        {
            
            // Configure API key authorization: auth_ticket
            Configuration.Default.ApiKey.Add("X-Auth-Token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Auth-Token", "Bearer");

            var apiInstance = new TicketApi();
            var ticket = ticket_example;  // String | ticket

            try
            {
                // deleteTicket
                Common_BooleanResponse result = apiInstance.deleteTicket(ticket);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TicketApi.deleteTicket: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: auth_ticket
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');

$api_instance = new Swagger\Client\Api\TicketApi();
$ticket = ticket_example; // String | ticket

try {
    $result = $api_instance->deleteTicket($ticket);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TicketApi->deleteTicket: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TicketApi;

# Configure API key authorization: auth_ticket
$WWW::SwaggerClient::Configuration::api_key->{'X-Auth-Token'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Auth-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::TicketApi->new();
my $ticket = ticket_example; # String | ticket

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

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: auth_ticket
swagger_client.configuration.api_key['X-Auth-Token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Auth-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.TicketApi()
ticket = ticket_example # String | ticket


try: 
    # deleteTicket
    api_response = api_instance.delete_ticket(ticket)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TicketApi->deleteTicket: %s\n" % e)

Parameters

Path parameters

Name	Description
ticket*	String ticket Required

Responses

Status: 200 - success

Schema

Status: 400 - The client made a request that the server could not understand (for example, the request syntax is incorrect).

Status: 401 - Not Authorized Yet, Credentials to be supplied

Status: 404 - No Resource Found

Status: 500 - The server could not fulfill the request.

Status: 501 - The server has not implemented the functionality required to fulfill the request.

Inventory API

addNetworkDevice

Network device POST api

Adds the device with given credential

/network-device

Usage and SDK Samples

Curl

curl -X POST -H "X-Auth-Token: [[apiKey]]" "http://{IP}:{PORT}/api/v1/network-device"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.InventoryApi;

import java.io.File;
import java.util.*;

public class InventoryApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: auth_ticket
        ApiKeyAuth auth_ticket = (ApiKeyAuth) defaultClient.getAuthentication("auth_ticket");
        auth_ticket.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //auth_ticket.setApiKeyPrefix("Token");

        InventoryApi apiInstance = new InventoryApi();
        Inventory_DeviceInfo inventoryDeviceInfo = ; // Inventory_DeviceInfo | Payload to hold device IP and credential information
        try {
            Discovery_DiscoveryResult result = apiInstance.addNetworkDevice(inventoryDeviceInfo);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InventoryApi#addNetworkDevice");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.InventoryApi;

public class InventoryApiExample {

    public static void main(String[] args) {
        InventoryApi apiInstance = new InventoryApi();
        Inventory_DeviceInfo inventoryDeviceInfo = ; // Inventory_DeviceInfo | Payload to hold device IP and credential information
        try {
            Discovery_DiscoveryResult result = apiInstance.addNetworkDevice(inventoryDeviceInfo);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InventoryApi#addNetworkDevice");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: auth_ticket)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Auth-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Auth-Token"];

Inventory_DeviceInfo *inventoryDeviceInfo = ; // Payload to hold device IP and credential information

InventoryApi *apiInstance = [[InventoryApi alloc] init];

// Network device POST api
[apiInstance addNetworkDeviceWith:inventoryDeviceInfo
              completionHandler: ^(Discovery_DiscoveryResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var CiscoPacketTracerNorthboundApiForNetworkControllerDevice = require('cisco_packet_tracer_northbound_api_for_network_controller_device');
var defaultClient = CiscoPacketTracerNorthboundApiForNetworkControllerDevice.ApiClient.instance;

// Configure API key authorization: auth_ticket
var auth_ticket = defaultClient.authentications['auth_ticket'];
auth_ticket.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//auth_ticket.apiKeyPrefix['X-Auth-Token'] = "Token"

var api = new CiscoPacketTracerNorthboundApiForNetworkControllerDevice.InventoryApi()

var inventoryDeviceInfo = ; // {Inventory_DeviceInfo} Payload to hold device IP and credential information


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.addNetworkDevice(inventoryDeviceInfo, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class addNetworkDeviceExample
    {
        public void main()
        {
            
            // Configure API key authorization: auth_ticket
            Configuration.Default.ApiKey.Add("X-Auth-Token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Auth-Token", "Bearer");

            var apiInstance = new InventoryApi();
            var inventoryDeviceInfo = new Inventory_DeviceInfo(); // Inventory_DeviceInfo | Payload to hold device IP and credential information

            try
            {
                // Network device POST api
                Discovery_DiscoveryResult result = apiInstance.addNetworkDevice(inventoryDeviceInfo);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling InventoryApi.addNetworkDevice: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: auth_ticket
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');

$api_instance = new Swagger\Client\Api\InventoryApi();
$inventoryDeviceInfo = ; // Inventory_DeviceInfo | Payload to hold device IP and credential information

try {
    $result = $api_instance->addNetworkDevice($inventoryDeviceInfo);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InventoryApi->addNetworkDevice: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::InventoryApi;

# Configure API key authorization: auth_ticket
$WWW::SwaggerClient::Configuration::api_key->{'X-Auth-Token'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Auth-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::InventoryApi->new();
my $inventoryDeviceInfo = WWW::SwaggerClient::Object::Inventory_DeviceInfo->new(); # Inventory_DeviceInfo | Payload to hold device IP and credential information

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

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: auth_ticket
swagger_client.configuration.api_key['X-Auth-Token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Auth-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.InventoryApi()
inventoryDeviceInfo =  # Inventory_DeviceInfo | Payload to hold device IP and credential information


try: 
    # Network device POST api
    api_response = api_instance.add_network_device(inventoryDeviceInfo)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling InventoryApi->addNetworkDevice: %s\n" % e)

Parameters

Body parameters

Name	Description
inventoryDeviceInfo *

Responses

Status: 200 - The request was successful. The result is contained in the response body.

Schema

Status: 201 - The POST request was fulfilled and a new resource has been created. Information about the resource is in the response body.

Status: 400 - The client made a request that the server could not understand (for example, the request syntax is incorrect).

Status: 401 - Not Authorized Yet, Credentials to be supplied

Status: 500 - The server could not fulfill the request.

Status: 501 - The server has not implemented the functionality required to fulfill the request.

deleteNetworkDeviceById

Delete network device by ID

Removes the network device for the given ID

/network-device/{id}

Usage and SDK Samples

Curl

curl -X DELETE -H "X-Auth-Token: [[apiKey]]" "http://{IP}:{PORT}/api/v1/network-device/{id}"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.InventoryApi;

import java.io.File;
import java.util.*;

public class InventoryApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: auth_ticket
        ApiKeyAuth auth_ticket = (ApiKeyAuth) defaultClient.getAuthentication("auth_ticket");
        auth_ticket.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //auth_ticket.setApiKeyPrefix("Token");

        InventoryApi apiInstance = new InventoryApi();
        String id = id_example; // String | Device ID
        try {
            Common_BooleanResponse result = apiInstance.deleteNetworkDeviceById(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InventoryApi#deleteNetworkDeviceById");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.InventoryApi;

public class InventoryApiExample {

    public static void main(String[] args) {
        InventoryApi apiInstance = new InventoryApi();
        String id = id_example; // String | Device ID
        try {
            Common_BooleanResponse result = apiInstance.deleteNetworkDeviceById(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InventoryApi#deleteNetworkDeviceById");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: auth_ticket)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Auth-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Auth-Token"];

String *id = id_example; // Device ID

InventoryApi *apiInstance = [[InventoryApi alloc] init];

// Delete network device by ID
[apiInstance deleteNetworkDeviceByIdWith:id
              completionHandler: ^(Common_BooleanResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var CiscoPacketTracerNorthboundApiForNetworkControllerDevice = require('cisco_packet_tracer_northbound_api_for_network_controller_device');
var defaultClient = CiscoPacketTracerNorthboundApiForNetworkControllerDevice.ApiClient.instance;

// Configure API key authorization: auth_ticket
var auth_ticket = defaultClient.authentications['auth_ticket'];
auth_ticket.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//auth_ticket.apiKeyPrefix['X-Auth-Token'] = "Token"

var api = new CiscoPacketTracerNorthboundApiForNetworkControllerDevice.InventoryApi()

var id = id_example; // {String} Device ID


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteNetworkDeviceById(id, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteNetworkDeviceByIdExample
    {
        public void main()
        {
            
            // Configure API key authorization: auth_ticket
            Configuration.Default.ApiKey.Add("X-Auth-Token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Auth-Token", "Bearer");

            var apiInstance = new InventoryApi();
            var id = id_example;  // String | Device ID

            try
            {
                // Delete network device by ID
                Common_BooleanResponse result = apiInstance.deleteNetworkDeviceById(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling InventoryApi.deleteNetworkDeviceById: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: auth_ticket
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');

$api_instance = new Swagger\Client\Api\InventoryApi();
$id = id_example; // String | Device ID

try {
    $result = $api_instance->deleteNetworkDeviceById($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InventoryApi->deleteNetworkDeviceById: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::InventoryApi;

# Configure API key authorization: auth_ticket
$WWW::SwaggerClient::Configuration::api_key->{'X-Auth-Token'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Auth-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::InventoryApi->new();
my $id = id_example; # String | Device ID

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

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: auth_ticket
swagger_client.configuration.api_key['X-Auth-Token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Auth-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.InventoryApi()
id = id_example # String | Device ID


try: 
    # Delete network device by ID
    api_response = api_instance.delete_network_device_by_id(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling InventoryApi->deleteNetworkDeviceById: %s\n" % e)

Parameters

Path parameters

Name	Description
id*	String Device ID Required

Responses

Status: 200 - The request was successful.

Schema

Status: 401 - Not Authorized Yet, Credentials to be supplied

Status: 404 - No Resource Found

Status: 500 - The server could not fulfill the request.

Status: 501 - The server has not implemented the functionality required to fulfill the request.

deleteNetworkDeviceByIp

Delete network device by IP Address

Removes the network device for the given IP address

/network-device/ip-address/{ipAddress}

Usage and SDK Samples

Curl

curl -X DELETE -H "X-Auth-Token: [[apiKey]]" "http://{IP}:{PORT}/api/v1/network-device/ip-address/{ipAddress}"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.InventoryApi;

import java.io.File;
import java.util.*;

public class InventoryApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: auth_ticket
        ApiKeyAuth auth_ticket = (ApiKeyAuth) defaultClient.getAuthentication("auth_ticket");
        auth_ticket.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //auth_ticket.setApiKeyPrefix("Token");

        InventoryApi apiInstance = new InventoryApi();
        String ipAddress = ipAddress_example; // String | Device IP Address
        try {
            Common_BooleanResponse result = apiInstance.deleteNetworkDeviceByIp(ipAddress);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InventoryApi#deleteNetworkDeviceByIp");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.InventoryApi;

public class InventoryApiExample {

    public static void main(String[] args) {
        InventoryApi apiInstance = new InventoryApi();
        String ipAddress = ipAddress_example; // String | Device IP Address
        try {
            Common_BooleanResponse result = apiInstance.deleteNetworkDeviceByIp(ipAddress);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InventoryApi#deleteNetworkDeviceByIp");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: auth_ticket)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Auth-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Auth-Token"];

String *ipAddress = ipAddress_example; // Device IP Address

InventoryApi *apiInstance = [[InventoryApi alloc] init];

// Delete network device by IP Address
[apiInstance deleteNetworkDeviceByIpWith:ipAddress
              completionHandler: ^(Common_BooleanResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var CiscoPacketTracerNorthboundApiForNetworkControllerDevice = require('cisco_packet_tracer_northbound_api_for_network_controller_device');
var defaultClient = CiscoPacketTracerNorthboundApiForNetworkControllerDevice.ApiClient.instance;

// Configure API key authorization: auth_ticket
var auth_ticket = defaultClient.authentications['auth_ticket'];
auth_ticket.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//auth_ticket.apiKeyPrefix['X-Auth-Token'] = "Token"

var api = new CiscoPacketTracerNorthboundApiForNetworkControllerDevice.InventoryApi()

var ipAddress = ipAddress_example; // {String} Device IP Address


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteNetworkDeviceByIp(ipAddress, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteNetworkDeviceByIpExample
    {
        public void main()
        {
            
            // Configure API key authorization: auth_ticket
            Configuration.Default.ApiKey.Add("X-Auth-Token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Auth-Token", "Bearer");

            var apiInstance = new InventoryApi();
            var ipAddress = ipAddress_example;  // String | Device IP Address

            try
            {
                // Delete network device by IP Address
                Common_BooleanResponse result = apiInstance.deleteNetworkDeviceByIp(ipAddress);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling InventoryApi.deleteNetworkDeviceByIp: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: auth_ticket
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');

$api_instance = new Swagger\Client\Api\InventoryApi();
$ipAddress = ipAddress_example; // String | Device IP Address

try {
    $result = $api_instance->deleteNetworkDeviceByIp($ipAddress);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InventoryApi->deleteNetworkDeviceByIp: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::InventoryApi;

# Configure API key authorization: auth_ticket
$WWW::SwaggerClient::Configuration::api_key->{'X-Auth-Token'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Auth-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::InventoryApi->new();
my $ipAddress = ipAddress_example; # String | Device IP Address

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

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: auth_ticket
swagger_client.configuration.api_key['X-Auth-Token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Auth-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.InventoryApi()
ipAddress = ipAddress_example # String | Device IP Address


try: 
    # Delete network device by IP Address
    api_response = api_instance.delete_network_device_by_ip(ipAddress)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling InventoryApi->deleteNetworkDeviceByIp: %s\n" % e)

Parameters

Path parameters

Name	Description
ipAddress*	String Device IP Address Required

Responses

Status: 200 - The request was successful.

Schema

Status: 401 - Not Authorized Yet, Credentials to be supplied

Status: 404 - No Resource Found

Status: 500 - The server could not fulfill the request.

Status: 501 - The server has not implemented the functionality required to fulfill the request.

getNetworkDeviceById

Retrieves network device by ID

Gets the network device for the given device ID

/network-device/{id}

Usage and SDK Samples

Curl

curl -X GET -H "X-Auth-Token: [[apiKey]]" "http://{IP}:{PORT}/api/v1/network-device/{id}"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.InventoryApi;

import java.io.File;
import java.util.*;

public class InventoryApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: auth_ticket
        ApiKeyAuth auth_ticket = (ApiKeyAuth) defaultClient.getAuthentication("auth_ticket");
        auth_ticket.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //auth_ticket.setApiKeyPrefix("Token");

        InventoryApi apiInstance = new InventoryApi();
        String id = id_example; // String | Device ID
        try {
            Inventory_NetworkDeviceResult result = apiInstance.getNetworkDeviceById(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InventoryApi#getNetworkDeviceById");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.InventoryApi;

public class InventoryApiExample {

    public static void main(String[] args) {
        InventoryApi apiInstance = new InventoryApi();
        String id = id_example; // String | Device ID
        try {
            Inventory_NetworkDeviceResult result = apiInstance.getNetworkDeviceById(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InventoryApi#getNetworkDeviceById");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: auth_ticket)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Auth-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Auth-Token"];

String *id = id_example; // Device ID

InventoryApi *apiInstance = [[InventoryApi alloc] init];

// Retrieves network device by ID
[apiInstance getNetworkDeviceByIdWith:id
              completionHandler: ^(Inventory_NetworkDeviceResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var CiscoPacketTracerNorthboundApiForNetworkControllerDevice = require('cisco_packet_tracer_northbound_api_for_network_controller_device');
var defaultClient = CiscoPacketTracerNorthboundApiForNetworkControllerDevice.ApiClient.instance;

// Configure API key authorization: auth_ticket
var auth_ticket = defaultClient.authentications['auth_ticket'];
auth_ticket.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//auth_ticket.apiKeyPrefix['X-Auth-Token'] = "Token"

var api = new CiscoPacketTracerNorthboundApiForNetworkControllerDevice.InventoryApi()

var id = id_example; // {String} Device ID


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getNetworkDeviceById(id, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getNetworkDeviceByIdExample
    {
        public void main()
        {
            
            // Configure API key authorization: auth_ticket
            Configuration.Default.ApiKey.Add("X-Auth-Token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Auth-Token", "Bearer");

            var apiInstance = new InventoryApi();
            var id = id_example;  // String | Device ID

            try
            {
                // Retrieves network device by ID
                Inventory_NetworkDeviceResult result = apiInstance.getNetworkDeviceById(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling InventoryApi.getNetworkDeviceById: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: auth_ticket
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');

$api_instance = new Swagger\Client\Api\InventoryApi();
$id = id_example; // String | Device ID

try {
    $result = $api_instance->getNetworkDeviceById($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InventoryApi->getNetworkDeviceById: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::InventoryApi;

# Configure API key authorization: auth_ticket
$WWW::SwaggerClient::Configuration::api_key->{'X-Auth-Token'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Auth-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::InventoryApi->new();
my $id = id_example; # String | Device ID

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

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: auth_ticket
swagger_client.configuration.api_key['X-Auth-Token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Auth-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.InventoryApi()
id = id_example # String | Device ID


try: 
    # Retrieves network device by ID
    api_response = api_instance.get_network_device_by_id(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling InventoryApi->getNetworkDeviceById: %s\n" % e)

Parameters

Path parameters

Name	Description
id*	String Device ID Required

Responses

Status: 200 - The request was successful. The result is contained in the response body.

Schema

Status: 401 - Not Authorized Yet, Credentials to be supplied

Status: 404 - No Resource Found

Status: 500 - The server could not fulfill the request.

Status: 501 - The server has not implemented the functionality required to fulfill the request.

getNetworkDeviceByIp

Retrieves network device by IP address

Gets the network device with the given IP address

/network-device/ip-address/{ipAddress}

Usage and SDK Samples

Curl

curl -X GET -H "X-Auth-Token: [[apiKey]]" "http://{IP}:{PORT}/api/v1/network-device/ip-address/{ipAddress}"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.InventoryApi;

import java.io.File;
import java.util.*;

public class InventoryApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: auth_ticket
        ApiKeyAuth auth_ticket = (ApiKeyAuth) defaultClient.getAuthentication("auth_ticket");
        auth_ticket.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //auth_ticket.setApiKeyPrefix("Token");

        InventoryApi apiInstance = new InventoryApi();
        String ipAddress = ipAddress_example; // String | Device IP address
        try {
            Inventory_NetworkDeviceResult result = apiInstance.getNetworkDeviceByIp(ipAddress);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InventoryApi#getNetworkDeviceByIp");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.InventoryApi;

public class InventoryApiExample {

    public static void main(String[] args) {
        InventoryApi apiInstance = new InventoryApi();
        String ipAddress = ipAddress_example; // String | Device IP address
        try {
            Inventory_NetworkDeviceResult result = apiInstance.getNetworkDeviceByIp(ipAddress);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InventoryApi#getNetworkDeviceByIp");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: auth_ticket)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Auth-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Auth-Token"];

String *ipAddress = ipAddress_example; // Device IP address

InventoryApi *apiInstance = [[InventoryApi alloc] init];

// Retrieves network device by IP address
[apiInstance getNetworkDeviceByIpWith:ipAddress
              completionHandler: ^(Inventory_NetworkDeviceResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var CiscoPacketTracerNorthboundApiForNetworkControllerDevice = require('cisco_packet_tracer_northbound_api_for_network_controller_device');
var defaultClient = CiscoPacketTracerNorthboundApiForNetworkControllerDevice.ApiClient.instance;

// Configure API key authorization: auth_ticket
var auth_ticket = defaultClient.authentications['auth_ticket'];
auth_ticket.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//auth_ticket.apiKeyPrefix['X-Auth-Token'] = "Token"

var api = new CiscoPacketTracerNorthboundApiForNetworkControllerDevice.InventoryApi()

var ipAddress = ipAddress_example; // {String} Device IP address


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getNetworkDeviceByIp(ipAddress, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getNetworkDeviceByIpExample
    {
        public void main()
        {
            
            // Configure API key authorization: auth_ticket
            Configuration.Default.ApiKey.Add("X-Auth-Token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Auth-Token", "Bearer");

            var apiInstance = new InventoryApi();
            var ipAddress = ipAddress_example;  // String | Device IP address

            try
            {
                // Retrieves network device by IP address
                Inventory_NetworkDeviceResult result = apiInstance.getNetworkDeviceByIp(ipAddress);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling InventoryApi.getNetworkDeviceByIp: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: auth_ticket
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');

$api_instance = new Swagger\Client\Api\InventoryApi();
$ipAddress = ipAddress_example; // String | Device IP address

try {
    $result = $api_instance->getNetworkDeviceByIp($ipAddress);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InventoryApi->getNetworkDeviceByIp: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::InventoryApi;

# Configure API key authorization: auth_ticket
$WWW::SwaggerClient::Configuration::api_key->{'X-Auth-Token'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Auth-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::InventoryApi->new();
my $ipAddress = ipAddress_example; # String | Device IP address

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

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: auth_ticket
swagger_client.configuration.api_key['X-Auth-Token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Auth-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.InventoryApi()
ipAddress = ipAddress_example # String | Device IP address


try: 
    # Retrieves network device by IP address
    api_response = api_instance.get_network_device_by_ip(ipAddress)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling InventoryApi->getNetworkDeviceByIp: %s\n" % e)

Parameters

Path parameters

Name	Description
ipAddress*	String Device IP address Required

Responses

Status: 200 - The request was successful. The result is contained in the response body.

Schema

Status: 401 - Not Authorized Yet, Credentials to be supplied

Status: 404 - No Resource Found

Status: 500 - The server could not fulfill the request.

Status: 501 - The server has not implemented the functionality required to fulfill the request.

getNetworkDeviceCount

Retrieves network device count by filters

Gets the count of network devices filtered by management IP address, mac address, hostname and location name.

/network-device/count

Usage and SDK Samples

Curl

curl -X GET -H "X-Auth-Token: [[apiKey]]" "http://{IP}:{PORT}/api/v1/network-device/count"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.InventoryApi;

import java.io.File;
import java.util.*;

public class InventoryApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: auth_ticket
        ApiKeyAuth auth_ticket = (ApiKeyAuth) defaultClient.getAuthentication("auth_ticket");
        auth_ticket.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //auth_ticket.setApiKeyPrefix("Token");

        InventoryApi apiInstance = new InventoryApi();
        try {
            Common_IntegerResponse result = apiInstance.getNetworkDeviceCount();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InventoryApi#getNetworkDeviceCount");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.InventoryApi;

public class InventoryApiExample {

    public static void main(String[] args) {
        InventoryApi apiInstance = new InventoryApi();
        try {
            Common_IntegerResponse result = apiInstance.getNetworkDeviceCount();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InventoryApi#getNetworkDeviceCount");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: auth_ticket)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Auth-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Auth-Token"];


InventoryApi *apiInstance = [[InventoryApi alloc] init];

// Retrieves network device count by filters
[apiInstance getNetworkDeviceCountWithCompletionHandler: 
              ^(Common_IntegerResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var CiscoPacketTracerNorthboundApiForNetworkControllerDevice = require('cisco_packet_tracer_northbound_api_for_network_controller_device');
var defaultClient = CiscoPacketTracerNorthboundApiForNetworkControllerDevice.ApiClient.instance;

// Configure API key authorization: auth_ticket
var auth_ticket = defaultClient.authentications['auth_ticket'];
auth_ticket.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//auth_ticket.apiKeyPrefix['X-Auth-Token'] = "Token"

var api = new CiscoPacketTracerNorthboundApiForNetworkControllerDevice.InventoryApi()

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getNetworkDeviceCount(callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getNetworkDeviceCountExample
    {
        public void main()
        {
            
            // Configure API key authorization: auth_ticket
            Configuration.Default.ApiKey.Add("X-Auth-Token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Auth-Token", "Bearer");

            var apiInstance = new InventoryApi();

            try
            {
                // Retrieves network device count by filters
                Common_IntegerResponse result = apiInstance.getNetworkDeviceCount();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling InventoryApi.getNetworkDeviceCount: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: auth_ticket
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');

$api_instance = new Swagger\Client\Api\InventoryApi();

try {
    $result = $api_instance->getNetworkDeviceCount();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InventoryApi->getNetworkDeviceCount: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::InventoryApi;

# Configure API key authorization: auth_ticket
$WWW::SwaggerClient::Configuration::api_key->{'X-Auth-Token'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Auth-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::InventoryApi->new();

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

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: auth_ticket
swagger_client.configuration.api_key['X-Auth-Token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Auth-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.InventoryApi()


try: 
    # Retrieves network device count by filters
    api_response = api_instance.get_network_device_count()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling InventoryApi->getNetworkDeviceCount: %s\n" % e)

Parameters

Responses

Status: 200 - The request was successful. The result is contained in the response body.

Schema

Status: 401 - Not Authorized Yet, Credentials to be supplied

Status: 500 - The server could not fulfill the request.

Status: 501 - The server has not implemented the functionality required to fulfill the request.

getNetworkDeviceRange

Retrieves network device by range

Gets the list of network devices for the given range.

/network-device/{startIndex}/{recordsToReturn}

Usage and SDK Samples

Curl

curl -X GET -H "X-Auth-Token: [[apiKey]]" "http://{IP}:{PORT}/api/v1/network-device/{startIndex}/{recordsToReturn}"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.InventoryApi;

import java.io.File;
import java.util.*;

public class InventoryApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: auth_ticket
        ApiKeyAuth auth_ticket = (ApiKeyAuth) defaultClient.getAuthentication("auth_ticket");
        auth_ticket.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //auth_ticket.setApiKeyPrefix("Token");

        InventoryApi apiInstance = new InventoryApi();
        Integer startIndex = 56; // Integer | Start index [0-254]
        Integer recordsToReturn = 56; // Integer | Number of records to return [0-255]
        try {
            Inventory_NetworkDeviceListResult result = apiInstance.getNetworkDeviceRange(startIndex, recordsToReturn);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InventoryApi#getNetworkDeviceRange");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.InventoryApi;

public class InventoryApiExample {

    public static void main(String[] args) {
        InventoryApi apiInstance = new InventoryApi();
        Integer startIndex = 56; // Integer | Start index [0-254]
        Integer recordsToReturn = 56; // Integer | Number of records to return [0-255]
        try {
            Inventory_NetworkDeviceListResult result = apiInstance.getNetworkDeviceRange(startIndex, recordsToReturn);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InventoryApi#getNetworkDeviceRange");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: auth_ticket)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Auth-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Auth-Token"];

Integer *startIndex = 56; // Start index [0-254]
Integer *recordsToReturn = 56; // Number of records to return [0-255]

InventoryApi *apiInstance = [[InventoryApi alloc] init];

// Retrieves network device by range
[apiInstance getNetworkDeviceRangeWith:startIndex
    recordsToReturn:recordsToReturn
              completionHandler: ^(Inventory_NetworkDeviceListResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var CiscoPacketTracerNorthboundApiForNetworkControllerDevice = require('cisco_packet_tracer_northbound_api_for_network_controller_device');
var defaultClient = CiscoPacketTracerNorthboundApiForNetworkControllerDevice.ApiClient.instance;

// Configure API key authorization: auth_ticket
var auth_ticket = defaultClient.authentications['auth_ticket'];
auth_ticket.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//auth_ticket.apiKeyPrefix['X-Auth-Token'] = "Token"

var api = new CiscoPacketTracerNorthboundApiForNetworkControllerDevice.InventoryApi()

var startIndex = 56; // {Integer} Start index [0-254]

var recordsToReturn = 56; // {Integer} Number of records to return [0-255]


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getNetworkDeviceRange(startIndex, recordsToReturn, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getNetworkDeviceRangeExample
    {
        public void main()
        {
            
            // Configure API key authorization: auth_ticket
            Configuration.Default.ApiKey.Add("X-Auth-Token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Auth-Token", "Bearer");

            var apiInstance = new InventoryApi();
            var startIndex = 56;  // Integer | Start index [0-254]
            var recordsToReturn = 56;  // Integer | Number of records to return [0-255]

            try
            {
                // Retrieves network device by range
                Inventory_NetworkDeviceListResult result = apiInstance.getNetworkDeviceRange(startIndex, recordsToReturn);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling InventoryApi.getNetworkDeviceRange: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: auth_ticket
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');

$api_instance = new Swagger\Client\Api\InventoryApi();
$startIndex = 56; // Integer | Start index [0-254]
$recordsToReturn = 56; // Integer | Number of records to return [0-255]

try {
    $result = $api_instance->getNetworkDeviceRange($startIndex, $recordsToReturn);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InventoryApi->getNetworkDeviceRange: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::InventoryApi;

# Configure API key authorization: auth_ticket
$WWW::SwaggerClient::Configuration::api_key->{'X-Auth-Token'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Auth-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::InventoryApi->new();
my $startIndex = 56; # Integer | Start index [0-254]
my $recordsToReturn = 56; # Integer | Number of records to return [0-255]

eval { 
    my $result = $api_instance->getNetworkDeviceRange(startIndex => $startIndex, recordsToReturn => $recordsToReturn);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling InventoryApi->getNetworkDeviceRange: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: auth_ticket
swagger_client.configuration.api_key['X-Auth-Token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Auth-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.InventoryApi()
startIndex = 56 # Integer | Start index [0-254]
recordsToReturn = 56 # Integer | Number of records to return [0-255]


try: 
    # Retrieves network device by range
    api_response = api_instance.get_network_device_range(startIndex, recordsToReturn)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling InventoryApi->getNetworkDeviceRange: %s\n" % e)

Parameters

Path parameters

Name	Description
startIndex*	Integer Start index [0-254] Required
recordsToReturn*	Integer Number of records to return [0-255] Required

Responses

Status: 200 - The request was successful. The result is contained in the response body.

Schema

Status: 400 - The client made a request that the server could not understand (for example, the request syntax is incorrect).

Status: 401 - Not Authorized Yet, Credentials to be supplied

Status: 404 - No Resource Found

Status: 500 - The server could not fulfill the request.

Status: 501 - The server has not implemented the functionality required to fulfill the request.

getNetworkDevices

Retrieves the network devices by filters

Gets the list of network devices. Network-Device List includes unsupported, managed, and unreachable. Devices with an unknown type due to unreachable will appear in the network-device list

/network-device

Usage and SDK Samples

Curl

curl -X GET -H "X-Auth-Token: [[apiKey]]" "http://{IP}:{PORT}/api/v1/network-device"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.InventoryApi;

import java.io.File;
import java.util.*;

public class InventoryApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: auth_ticket
        ApiKeyAuth auth_ticket = (ApiKeyAuth) defaultClient.getAuthentication("auth_ticket");
        auth_ticket.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //auth_ticket.setApiKeyPrefix("Token");

        InventoryApi apiInstance = new InventoryApi();
        try {
            Inventory_NetworkDeviceListResult result = apiInstance.getNetworkDevices();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InventoryApi#getNetworkDevices");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.InventoryApi;

public class InventoryApiExample {

    public static void main(String[] args) {
        InventoryApi apiInstance = new InventoryApi();
        try {
            Inventory_NetworkDeviceListResult result = apiInstance.getNetworkDevices();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InventoryApi#getNetworkDevices");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: auth_ticket)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Auth-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Auth-Token"];


InventoryApi *apiInstance = [[InventoryApi alloc] init];

// Retrieves the network devices by filters
[apiInstance getNetworkDevicesWithCompletionHandler: 
              ^(Inventory_NetworkDeviceListResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var CiscoPacketTracerNorthboundApiForNetworkControllerDevice = require('cisco_packet_tracer_northbound_api_for_network_controller_device');
var defaultClient = CiscoPacketTracerNorthboundApiForNetworkControllerDevice.ApiClient.instance;

// Configure API key authorization: auth_ticket
var auth_ticket = defaultClient.authentications['auth_ticket'];
auth_ticket.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//auth_ticket.apiKeyPrefix['X-Auth-Token'] = "Token"

var api = new CiscoPacketTracerNorthboundApiForNetworkControllerDevice.InventoryApi()

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getNetworkDevices(callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getNetworkDevicesExample
    {
        public void main()
        {
            
            // Configure API key authorization: auth_ticket
            Configuration.Default.ApiKey.Add("X-Auth-Token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Auth-Token", "Bearer");

            var apiInstance = new InventoryApi();

            try
            {
                // Retrieves the network devices by filters
                Inventory_NetworkDeviceListResult result = apiInstance.getNetworkDevices();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling InventoryApi.getNetworkDevices: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: auth_ticket
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');

$api_instance = new Swagger\Client\Api\InventoryApi();

try {
    $result = $api_instance->getNetworkDevices();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InventoryApi->getNetworkDevices: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::InventoryApi;

# Configure API key authorization: auth_ticket
$WWW::SwaggerClient::Configuration::api_key->{'X-Auth-Token'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Auth-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::InventoryApi->new();

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

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: auth_ticket
swagger_client.configuration.api_key['X-Auth-Token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Auth-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.InventoryApi()


try: 
    # Retrieves the network devices by filters
    api_response = api_instance.get_network_devices()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling InventoryApi->getNetworkDevices: %s\n" % e)

Parameters

Responses

Status: 200 - The request was successful. The result is contained in the response body.

Schema

Status: 401 - Not Authorized Yet, Credentials to be supplied

Status: 500 - The server could not fulfill the request.

Status: 501 - The server has not implemented the functionality required to fulfill the request.

updateNetworkDevice

Network device sync api

Sync the devices provided as input

/network-device

Usage and SDK Samples

Curl

curl -X PUT -H "X-Auth-Token: [[apiKey]]" "http://{IP}:{PORT}/api/v1/network-device"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.InventoryApi;

import java.io.File;
import java.util.*;

public class InventoryApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: auth_ticket
        ApiKeyAuth auth_ticket = (ApiKeyAuth) defaultClient.getAuthentication("auth_ticket");
        auth_ticket.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //auth_ticket.setApiKeyPrefix("Token");

        InventoryApi apiInstance = new InventoryApi();
        Inventory_DeviceInfo inventoryDeviceInfo = ; // Inventory_DeviceInfo | Payload to hold device IP and credential information
        try {
            Discovery_DiscoveryResult result = apiInstance.updateNetworkDevice(inventoryDeviceInfo);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InventoryApi#updateNetworkDevice");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.InventoryApi;

public class InventoryApiExample {

    public static void main(String[] args) {
        InventoryApi apiInstance = new InventoryApi();
        Inventory_DeviceInfo inventoryDeviceInfo = ; // Inventory_DeviceInfo | Payload to hold device IP and credential information
        try {
            Discovery_DiscoveryResult result = apiInstance.updateNetworkDevice(inventoryDeviceInfo);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InventoryApi#updateNetworkDevice");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: auth_ticket)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Auth-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Auth-Token"];

Inventory_DeviceInfo *inventoryDeviceInfo = ; // Payload to hold device IP and credential information

InventoryApi *apiInstance = [[InventoryApi alloc] init];

// Network device sync api
[apiInstance updateNetworkDeviceWith:inventoryDeviceInfo
              completionHandler: ^(Discovery_DiscoveryResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var CiscoPacketTracerNorthboundApiForNetworkControllerDevice = require('cisco_packet_tracer_northbound_api_for_network_controller_device');
var defaultClient = CiscoPacketTracerNorthboundApiForNetworkControllerDevice.ApiClient.instance;

// Configure API key authorization: auth_ticket
var auth_ticket = defaultClient.authentications['auth_ticket'];
auth_ticket.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//auth_ticket.apiKeyPrefix['X-Auth-Token'] = "Token"

var api = new CiscoPacketTracerNorthboundApiForNetworkControllerDevice.InventoryApi()

var inventoryDeviceInfo = ; // {Inventory_DeviceInfo} Payload to hold device IP and credential information


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateNetworkDevice(inventoryDeviceInfo, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateNetworkDeviceExample
    {
        public void main()
        {
            
            // Configure API key authorization: auth_ticket
            Configuration.Default.ApiKey.Add("X-Auth-Token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Auth-Token", "Bearer");

            var apiInstance = new InventoryApi();
            var inventoryDeviceInfo = new Inventory_DeviceInfo(); // Inventory_DeviceInfo | Payload to hold device IP and credential information

            try
            {
                // Network device sync api
                Discovery_DiscoveryResult result = apiInstance.updateNetworkDevice(inventoryDeviceInfo);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling InventoryApi.updateNetworkDevice: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: auth_ticket
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');

$api_instance = new Swagger\Client\Api\InventoryApi();
$inventoryDeviceInfo = ; // Inventory_DeviceInfo | Payload to hold device IP and credential information

try {
    $result = $api_instance->updateNetworkDevice($inventoryDeviceInfo);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InventoryApi->updateNetworkDevice: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::InventoryApi;

# Configure API key authorization: auth_ticket
$WWW::SwaggerClient::Configuration::api_key->{'X-Auth-Token'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Auth-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::InventoryApi->new();
my $inventoryDeviceInfo = WWW::SwaggerClient::Object::Inventory_DeviceInfo->new(); # Inventory_DeviceInfo | Payload to hold device IP and credential information

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

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: auth_ticket
swagger_client.configuration.api_key['X-Auth-Token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Auth-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.InventoryApi()
inventoryDeviceInfo =  # Inventory_DeviceInfo | Payload to hold device IP and credential information


try: 
    # Network device sync api
    api_response = api_instance.update_network_device(inventoryDeviceInfo)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling InventoryApi->updateNetworkDevice: %s\n" % e)

Parameters

Body parameters

Name	Description
inventoryDeviceInfo *

Responses

Status: 200 - The request was successful. The result is contained in the response body.

Schema

Status: 400 - The client made a request that the server could not understand (for example, the request syntax is incorrect).

Status: 401 - Not Authorized Yet, Credentials to be supplied

Status: 500 - The server could not fulfill the request.

Status: 501 - The server has not implemented the functionality required to fulfill the request.

Host Operation API

deleteHostByIp

Delete the host by IP Address

Removes the host for the given IP address

/host/ip-address/{ipAddress}

Usage and SDK Samples

Curl

curl -X DELETE -H "X-Auth-Token: [[apiKey]]" "http://{IP}:{PORT}/api/v1/host/ip-address/{ipAddress}"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.HostOperationApi;

import java.io.File;
import java.util.*;

public class HostOperationApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: auth_ticket
        ApiKeyAuth auth_ticket = (ApiKeyAuth) defaultClient.getAuthentication("auth_ticket");
        auth_ticket.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //auth_ticket.setApiKeyPrefix("Token");

        HostOperationApi apiInstance = new HostOperationApi();
        String ipAddress = ipAddress_example; // String | Device IP Address
        try {
            Common_BooleanResponse result = apiInstance.deleteHostByIp(ipAddress);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling HostOperationApi#deleteHostByIp");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.HostOperationApi;

public class HostOperationApiExample {

    public static void main(String[] args) {
        HostOperationApi apiInstance = new HostOperationApi();
        String ipAddress = ipAddress_example; // String | Device IP Address
        try {
            Common_BooleanResponse result = apiInstance.deleteHostByIp(ipAddress);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling HostOperationApi#deleteHostByIp");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: auth_ticket)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Auth-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Auth-Token"];

String *ipAddress = ipAddress_example; // Device IP Address

HostOperationApi *apiInstance = [[HostOperationApi alloc] init];

// Delete the host by IP Address
[apiInstance deleteHostByIpWith:ipAddress
              completionHandler: ^(Common_BooleanResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var CiscoPacketTracerNorthboundApiForNetworkControllerDevice = require('cisco_packet_tracer_northbound_api_for_network_controller_device');
var defaultClient = CiscoPacketTracerNorthboundApiForNetworkControllerDevice.ApiClient.instance;

// Configure API key authorization: auth_ticket
var auth_ticket = defaultClient.authentications['auth_ticket'];
auth_ticket.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//auth_ticket.apiKeyPrefix['X-Auth-Token'] = "Token"

var api = new CiscoPacketTracerNorthboundApiForNetworkControllerDevice.HostOperationApi()

var ipAddress = ipAddress_example; // {String} Device IP Address


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteHostByIp(ipAddress, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteHostByIpExample
    {
        public void main()
        {
            
            // Configure API key authorization: auth_ticket
            Configuration.Default.ApiKey.Add("X-Auth-Token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Auth-Token", "Bearer");

            var apiInstance = new HostOperationApi();
            var ipAddress = ipAddress_example;  // String | Device IP Address

            try
            {
                // Delete the host by IP Address
                Common_BooleanResponse result = apiInstance.deleteHostByIp(ipAddress);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling HostOperationApi.deleteHostByIp: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: auth_ticket
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');

$api_instance = new Swagger\Client\Api\HostOperationApi();
$ipAddress = ipAddress_example; // String | Device IP Address

try {
    $result = $api_instance->deleteHostByIp($ipAddress);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling HostOperationApi->deleteHostByIp: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::HostOperationApi;

# Configure API key authorization: auth_ticket
$WWW::SwaggerClient::Configuration::api_key->{'X-Auth-Token'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Auth-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::HostOperationApi->new();
my $ipAddress = ipAddress_example; # String | Device IP Address

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

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: auth_ticket
swagger_client.configuration.api_key['X-Auth-Token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Auth-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.HostOperationApi()
ipAddress = ipAddress_example # String | Device IP Address


try: 
    # Delete the host by IP Address
    api_response = api_instance.delete_host_by_ip(ipAddress)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling HostOperationApi->deleteHostByIp: %s\n" % e)

Parameters

Path parameters

Name	Description
ipAddress*	String Device IP Address Required

Responses

Status: 200 - The request was successful.

Schema

Status: 401 - Not Authorized Yet, Credentials to be supplied

Status: 404 - No Resource Found

Status: 500 - The server could not fulfill the request.

Status: 501 - The server has not implemented the functionality required to fulfill the request.

getHostById

Get Host By Id

Retrieves host based on id

/host/{id}

Usage and SDK Samples

Curl

curl -X GET -H "X-Auth-Token: [[apiKey]]" "http://{IP}:{PORT}/api/v1/host/{id}"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.HostOperationApi;

import java.io.File;
import java.util.*;

public class HostOperationApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: auth_ticket
        ApiKeyAuth auth_ticket = (ApiKeyAuth) defaultClient.getAuthentication("auth_ticket");
        auth_ticket.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //auth_ticket.setApiKeyPrefix("Token");

        HostOperationApi apiInstance = new HostOperationApi();
        String id = id_example; // String | The id of the host
        try {
            HostOperation_HostResult result = apiInstance.getHostById(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling HostOperationApi#getHostById");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.HostOperationApi;

public class HostOperationApiExample {

    public static void main(String[] args) {
        HostOperationApi apiInstance = new HostOperationApi();
        String id = id_example; // String | The id of the host
        try {
            HostOperation_HostResult result = apiInstance.getHostById(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling HostOperationApi#getHostById");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: auth_ticket)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Auth-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Auth-Token"];

String *id = id_example; // The id of the host

HostOperationApi *apiInstance = [[HostOperationApi alloc] init];

// Get Host By Id
[apiInstance getHostByIdWith:id
              completionHandler: ^(HostOperation_HostResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var CiscoPacketTracerNorthboundApiForNetworkControllerDevice = require('cisco_packet_tracer_northbound_api_for_network_controller_device');
var defaultClient = CiscoPacketTracerNorthboundApiForNetworkControllerDevice.ApiClient.instance;

// Configure API key authorization: auth_ticket
var auth_ticket = defaultClient.authentications['auth_ticket'];
auth_ticket.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//auth_ticket.apiKeyPrefix['X-Auth-Token'] = "Token"

var api = new CiscoPacketTracerNorthboundApiForNetworkControllerDevice.HostOperationApi()

var id = id_example; // {String} The id of the host


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getHostById(id, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getHostByIdExample
    {
        public void main()
        {
            
            // Configure API key authorization: auth_ticket
            Configuration.Default.ApiKey.Add("X-Auth-Token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Auth-Token", "Bearer");

            var apiInstance = new HostOperationApi();
            var id = id_example;  // String | The id of the host

            try
            {
                // Get Host By Id
                HostOperation_HostResult result = apiInstance.getHostById(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling HostOperationApi.getHostById: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: auth_ticket
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');

$api_instance = new Swagger\Client\Api\HostOperationApi();
$id = id_example; // String | The id of the host

try {
    $result = $api_instance->getHostById($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling HostOperationApi->getHostById: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::HostOperationApi;

# Configure API key authorization: auth_ticket
$WWW::SwaggerClient::Configuration::api_key->{'X-Auth-Token'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Auth-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::HostOperationApi->new();
my $id = id_example; # String | The id of the host

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

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: auth_ticket
swagger_client.configuration.api_key['X-Auth-Token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Auth-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.HostOperationApi()
id = id_example # String | The id of the host


try: 
    # Get Host By Id
    api_response = api_instance.get_host_by_id(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling HostOperationApi->getHostById: %s\n" % e)

Parameters

Path parameters

Name	Description
id*	String The id of the host Required

Responses

Status: 200 - The request was successful. The result is contained in the response body.

Schema

Status: 401 - The server recognizes the authentication credentials, but the client is not authorized to perform this request.

Status: 404 - No Resource Found

Status: 500 - The server could not fulfill the request.

Status: 501 - The server has not implemented the functionality required to fulfill the request.

getHostByIp

Retrieves a host by IP address

Gets the host with the given IP address

/host/ip-address/{ipAddress}

Usage and SDK Samples

Curl

curl -X GET -H "X-Auth-Token: [[apiKey]]" "http://{IP}:{PORT}/api/v1/host/ip-address/{ipAddress}"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.HostOperationApi;

import java.io.File;
import java.util.*;

public class HostOperationApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: auth_ticket
        ApiKeyAuth auth_ticket = (ApiKeyAuth) defaultClient.getAuthentication("auth_ticket");
        auth_ticket.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //auth_ticket.setApiKeyPrefix("Token");

        HostOperationApi apiInstance = new HostOperationApi();
        String ipAddress = ipAddress_example; // String | Host IP address
        try {
            HostOperation_HostResult result = apiInstance.getHostByIp(ipAddress);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling HostOperationApi#getHostByIp");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.HostOperationApi;

public class HostOperationApiExample {

    public static void main(String[] args) {
        HostOperationApi apiInstance = new HostOperationApi();
        String ipAddress = ipAddress_example; // String | Host IP address
        try {
            HostOperation_HostResult result = apiInstance.getHostByIp(ipAddress);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling HostOperationApi#getHostByIp");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: auth_ticket)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Auth-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Auth-Token"];

String *ipAddress = ipAddress_example; // Host IP address

HostOperationApi *apiInstance = [[HostOperationApi alloc] init];

// Retrieves a host by IP address
[apiInstance getHostByIpWith:ipAddress
              completionHandler: ^(HostOperation_HostResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var CiscoPacketTracerNorthboundApiForNetworkControllerDevice = require('cisco_packet_tracer_northbound_api_for_network_controller_device');
var defaultClient = CiscoPacketTracerNorthboundApiForNetworkControllerDevice.ApiClient.instance;

// Configure API key authorization: auth_ticket
var auth_ticket = defaultClient.authentications['auth_ticket'];
auth_ticket.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//auth_ticket.apiKeyPrefix['X-Auth-Token'] = "Token"

var api = new CiscoPacketTracerNorthboundApiForNetworkControllerDevice.HostOperationApi()

var ipAddress = ipAddress_example; // {String} Host IP address


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getHostByIp(ipAddress, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getHostByIpExample
    {
        public void main()
        {
            
            // Configure API key authorization: auth_ticket
            Configuration.Default.ApiKey.Add("X-Auth-Token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Auth-Token", "Bearer");

            var apiInstance = new HostOperationApi();
            var ipAddress = ipAddress_example;  // String | Host IP address

            try
            {
                // Retrieves a host by IP address
                HostOperation_HostResult result = apiInstance.getHostByIp(ipAddress);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling HostOperationApi.getHostByIp: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: auth_ticket
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');

$api_instance = new Swagger\Client\Api\HostOperationApi();
$ipAddress = ipAddress_example; // String | Host IP address

try {
    $result = $api_instance->getHostByIp($ipAddress);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling HostOperationApi->getHostByIp: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::HostOperationApi;

# Configure API key authorization: auth_ticket
$WWW::SwaggerClient::Configuration::api_key->{'X-Auth-Token'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Auth-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::HostOperationApi->new();
my $ipAddress = ipAddress_example; # String | Host IP address

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

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: auth_ticket
swagger_client.configuration.api_key['X-Auth-Token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Auth-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.HostOperationApi()
ipAddress = ipAddress_example # String | Host IP address


try: 
    # Retrieves a host by IP address
    api_response = api_instance.get_host_by_ip(ipAddress)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling HostOperationApi->getHostByIp: %s\n" % e)

Parameters

Path parameters

Name	Description
ipAddress*	String Host IP address Required

Responses

Status: 200 - The request was successful. The result is contained in the response body.

Schema

Status: 401 - Not Authorized Yet, Credentials to be supplied

Status: 404 - No Resource Found

Status: 500 - The server could not fulfill the request.

Status: 501 - The server has not implemented the functionality required to fulfill the request.

getHostCount

Get Host Count

Gives total number of hosts

/host/count

Usage and SDK Samples

Curl

curl -X GET -H "X-Auth-Token: [[apiKey]]" "http://{IP}:{PORT}/api/v1/host/count?hostName=&hostMac=&hostType=&connectedInterfaceName=&hostIp=&connectedNetworkDeviceIpAddress=&subType=&filterOperation="

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.HostOperationApi;

import java.io.File;
import java.util.*;

public class HostOperationApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: auth_ticket
        ApiKeyAuth auth_ticket = (ApiKeyAuth) defaultClient.getAuthentication("auth_ticket");
        auth_ticket.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //auth_ticket.setApiKeyPrefix("Token");

        HostOperationApi apiInstance = new HostOperationApi();
        array[String] hostName = ; // array[String] | Host name
        array[String] hostMac = ; // array[String] | Mac address of the host
        array[String] hostType = ; // array[String] | Type of the host. Available options are Wired, Wireless
        array[String] connectedInterfaceName = ; // array[String] | Name of the interface to which host gets connected
        array[String] hostIp = ; // array[String] | Ip address of the host
        array[String] connectedNetworkDeviceIpAddress = ; // array[String] | Id of the network device to which host gets connected
        array[String] subType = ; // array[String] | UNKNOWN or IP_PHONE or TELEPRESENCE or VIDEO_SURVEILLANCE_IP_CAMERA or VIDEO_ENDPOINT
        String filterOperation = filterOperation_example; // String | startswith/contains/endswith
        try {
            Common_IntegerResponse result = apiInstance.getHostCount(hostName, hostMac, hostType, connectedInterfaceName, hostIp, connectedNetworkDeviceIpAddress, subType, filterOperation);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling HostOperationApi#getHostCount");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.HostOperationApi;

public class HostOperationApiExample {

    public static void main(String[] args) {
        HostOperationApi apiInstance = new HostOperationApi();
        array[String] hostName = ; // array[String] | Host name
        array[String] hostMac = ; // array[String] | Mac address of the host
        array[String] hostType = ; // array[String] | Type of the host. Available options are Wired, Wireless
        array[String] connectedInterfaceName = ; // array[String] | Name of the interface to which host gets connected
        array[String] hostIp = ; // array[String] | Ip address of the host
        array[String] connectedNetworkDeviceIpAddress = ; // array[String] | Id of the network device to which host gets connected
        array[String] subType = ; // array[String] | UNKNOWN or IP_PHONE or TELEPRESENCE or VIDEO_SURVEILLANCE_IP_CAMERA or VIDEO_ENDPOINT
        String filterOperation = filterOperation_example; // String | startswith/contains/endswith
        try {
            Common_IntegerResponse result = apiInstance.getHostCount(hostName, hostMac, hostType, connectedInterfaceName, hostIp, connectedNetworkDeviceIpAddress, subType, filterOperation);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling HostOperationApi#getHostCount");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: auth_ticket)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Auth-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Auth-Token"];

array[String] *hostName = ; // Host name (optional)
array[String] *hostMac = ; // Mac address of the host (optional)
array[String] *hostType = ; // Type of the host. Available options are Wired, Wireless (optional)
array[String] *connectedInterfaceName = ; // Name of the interface to which host gets connected (optional)
array[String] *hostIp = ; // Ip address of the host (optional)
array[String] *connectedNetworkDeviceIpAddress = ; // Id of the network device to which host gets connected (optional)
array[String] *subType = ; // UNKNOWN or IP_PHONE or TELEPRESENCE or VIDEO_SURVEILLANCE_IP_CAMERA or VIDEO_ENDPOINT (optional)
String *filterOperation = filterOperation_example; // startswith/contains/endswith (optional)

HostOperationApi *apiInstance = [[HostOperationApi alloc] init];

// Get Host Count
[apiInstance getHostCountWith:hostName
    hostMac:hostMac
    hostType:hostType
    connectedInterfaceName:connectedInterfaceName
    hostIp:hostIp
    connectedNetworkDeviceIpAddress:connectedNetworkDeviceIpAddress
    subType:subType
    filterOperation:filterOperation
              completionHandler: ^(Common_IntegerResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var CiscoPacketTracerNorthboundApiForNetworkControllerDevice = require('cisco_packet_tracer_northbound_api_for_network_controller_device');
var defaultClient = CiscoPacketTracerNorthboundApiForNetworkControllerDevice.ApiClient.instance;

// Configure API key authorization: auth_ticket
var auth_ticket = defaultClient.authentications['auth_ticket'];
auth_ticket.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//auth_ticket.apiKeyPrefix['X-Auth-Token'] = "Token"

var api = new CiscoPacketTracerNorthboundApiForNetworkControllerDevice.HostOperationApi()

var opts = { 
  'hostName': , // {array[String]} Host name
  'hostMac': , // {array[String]} Mac address of the host
  'hostType': , // {array[String]} Type of the host. Available options are Wired, Wireless
  'connectedInterfaceName': , // {array[String]} Name of the interface to which host gets connected
  'hostIp': , // {array[String]} Ip address of the host
  'connectedNetworkDeviceIpAddress': , // {array[String]} Id of the network device to which host gets connected
  'subType': , // {array[String]} UNKNOWN or IP_PHONE or TELEPRESENCE or VIDEO_SURVEILLANCE_IP_CAMERA or VIDEO_ENDPOINT
  'filterOperation': filterOperation_example // {String} startswith/contains/endswith
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getHostCount(opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getHostCountExample
    {
        public void main()
        {
            
            // Configure API key authorization: auth_ticket
            Configuration.Default.ApiKey.Add("X-Auth-Token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Auth-Token", "Bearer");

            var apiInstance = new HostOperationApi();
            var hostName = new array[String](); // array[String] | Host name (optional) 
            var hostMac = new array[String](); // array[String] | Mac address of the host (optional) 
            var hostType = new array[String](); // array[String] | Type of the host. Available options are Wired, Wireless (optional) 
            var connectedInterfaceName = new array[String](); // array[String] | Name of the interface to which host gets connected (optional) 
            var hostIp = new array[String](); // array[String] | Ip address of the host (optional) 
            var connectedNetworkDeviceIpAddress = new array[String](); // array[String] | Id of the network device to which host gets connected (optional) 
            var subType = new array[String](); // array[String] | UNKNOWN or IP_PHONE or TELEPRESENCE or VIDEO_SURVEILLANCE_IP_CAMERA or VIDEO_ENDPOINT (optional) 
            var filterOperation = filterOperation_example;  // String | startswith/contains/endswith (optional) 

            try
            {
                // Get Host Count
                Common_IntegerResponse result = apiInstance.getHostCount(hostName, hostMac, hostType, connectedInterfaceName, hostIp, connectedNetworkDeviceIpAddress, subType, filterOperation);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling HostOperationApi.getHostCount: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: auth_ticket
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');

$api_instance = new Swagger\Client\Api\HostOperationApi();
$hostName = ; // array[String] | Host name
$hostMac = ; // array[String] | Mac address of the host
$hostType = ; // array[String] | Type of the host. Available options are Wired, Wireless
$connectedInterfaceName = ; // array[String] | Name of the interface to which host gets connected
$hostIp = ; // array[String] | Ip address of the host
$connectedNetworkDeviceIpAddress = ; // array[String] | Id of the network device to which host gets connected
$subType = ; // array[String] | UNKNOWN or IP_PHONE or TELEPRESENCE or VIDEO_SURVEILLANCE_IP_CAMERA or VIDEO_ENDPOINT
$filterOperation = filterOperation_example; // String | startswith/contains/endswith

try {
    $result = $api_instance->getHostCount($hostName, $hostMac, $hostType, $connectedInterfaceName, $hostIp, $connectedNetworkDeviceIpAddress, $subType, $filterOperation);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling HostOperationApi->getHostCount: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::HostOperationApi;

# Configure API key authorization: auth_ticket
$WWW::SwaggerClient::Configuration::api_key->{'X-Auth-Token'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Auth-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::HostOperationApi->new();
my $hostName = []; # array[String] | Host name
my $hostMac = []; # array[String] | Mac address of the host
my $hostType = []; # array[String] | Type of the host. Available options are Wired, Wireless
my $connectedInterfaceName = []; # array[String] | Name of the interface to which host gets connected
my $hostIp = []; # array[String] | Ip address of the host
my $connectedNetworkDeviceIpAddress = []; # array[String] | Id of the network device to which host gets connected
my $subType = []; # array[String] | UNKNOWN or IP_PHONE or TELEPRESENCE or VIDEO_SURVEILLANCE_IP_CAMERA or VIDEO_ENDPOINT
my $filterOperation = filterOperation_example; # String | startswith/contains/endswith

eval { 
    my $result = $api_instance->getHostCount(hostName => $hostName, hostMac => $hostMac, hostType => $hostType, connectedInterfaceName => $connectedInterfaceName, hostIp => $hostIp, connectedNetworkDeviceIpAddress => $connectedNetworkDeviceIpAddress, subType => $subType, filterOperation => $filterOperation);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling HostOperationApi->getHostCount: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: auth_ticket
swagger_client.configuration.api_key['X-Auth-Token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Auth-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.HostOperationApi()
hostName =  # array[String] | Host name (optional)
hostMac =  # array[String] | Mac address of the host (optional)
hostType =  # array[String] | Type of the host. Available options are Wired, Wireless (optional)
connectedInterfaceName =  # array[String] | Name of the interface to which host gets connected (optional)
hostIp =  # array[String] | Ip address of the host (optional)
connectedNetworkDeviceIpAddress =  # array[String] | Id of the network device to which host gets connected (optional)
subType =  # array[String] | UNKNOWN or IP_PHONE or TELEPRESENCE or VIDEO_SURVEILLANCE_IP_CAMERA or VIDEO_ENDPOINT (optional)
filterOperation = filterOperation_example # String | startswith/contains/endswith (optional)


try: 
    # Get Host Count
    api_response = api_instance.get_host_count(hostName=hostName, hostMac=hostMac, hostType=hostType, connectedInterfaceName=connectedInterfaceName, hostIp=hostIp, connectedNetworkDeviceIpAddress=connectedNetworkDeviceIpAddress, subType=subType, filterOperation=filterOperation)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling HostOperationApi->getHostCount: %s\n" % e)

Parameters

Query parameters

Name	Description
hostName	array[String] Host name
hostMac	array[String] Mac address of the host
hostType	array[String] Type of the host. Available options are Wired, Wireless
connectedInterfaceName	array[String] Name of the interface to which host gets connected
hostIp	array[String] Ip address of the host
connectedNetworkDeviceIpAddress	array[String] Id of the network device to which host gets connected
subType	array[String] UNKNOWN or IP_PHONE or TELEPRESENCE or VIDEO_SURVEILLANCE_IP_CAMERA or VIDEO_ENDPOINT
filterOperation	String startswith/contains/endswith

Responses

Status: 200 - The request was successful. The result is contained in the response body.

Schema

Status: 401 - The server recognizes the authentication credentials, but the client is not authorized to perform this request.

Status: 500 - The server could not fulfill the request.

Status: 501 - The server has not implemented the functionality required to fulfill the request.

getHosts

Get Hosts

Retrieve hosts

/host

Usage and SDK Samples

Curl

curl -X GET -H "X-Auth-Token: [[apiKey]]" "http://{IP}:{PORT}/api/v1/host?limit=&offset=&sortBy=&order=&hostName=&hostMac=&hostType=&connectedInterfaceName=&hostIp=&connectedNetworkDeviceIpAddress=&subType=&filterOperation="

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.HostOperationApi;

import java.io.File;
import java.util.*;

public class HostOperationApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: auth_ticket
        ApiKeyAuth auth_ticket = (ApiKeyAuth) defaultClient.getAuthentication("auth_ticket");
        auth_ticket.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //auth_ticket.setApiKeyPrefix("Token");

        HostOperationApi apiInstance = new HostOperationApi();
        String limit = limit_example; // String | Limit
        String offset = offset_example; // String | Offset
        String sortBy = sortBy_example; // String | Sort by
        String order = order_example; // String | order
        array[String] hostName = ; // array[String] | Host name
        array[String] hostMac = ; // array[String] | Mac address of the host
        array[String] hostType = ; // array[String] | Type of the host. Available options are Wired, Wireless
        array[String] connectedInterfaceName = ; // array[String] | Name of the interface to which host gets connected
        array[String] hostIp = ; // array[String] | Ip address of the host
        array[String] connectedNetworkDeviceIpAddress = ; // array[String] | Id of the network device to which host gets connected
        array[String] subType = ; // array[String] | UNKNOWN or IP_PHONE or TELEPRESENCE or VIDEO_SURVEILLANCE_IP_CAMERA or VIDEO_ENDPOINT
        String filterOperation = filterOperation_example; // String | startswith/contains/endswith
        try {
            HostOperation_HostListResult result = apiInstance.getHosts(limit, offset, sortBy, order, hostName, hostMac, hostType, connectedInterfaceName, hostIp, connectedNetworkDeviceIpAddress, subType, filterOperation);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling HostOperationApi#getHosts");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.HostOperationApi;

public class HostOperationApiExample {

    public static void main(String[] args) {
        HostOperationApi apiInstance = new HostOperationApi();
        String limit = limit_example; // String | Limit
        String offset = offset_example; // String | Offset
        String sortBy = sortBy_example; // String | Sort by
        String order = order_example; // String | order
        array[String] hostName = ; // array[String] | Host name
        array[String] hostMac = ; // array[String] | Mac address of the host
        array[String] hostType = ; // array[String] | Type of the host. Available options are Wired, Wireless
        array[String] connectedInterfaceName = ; // array[String] | Name of the interface to which host gets connected
        array[String] hostIp = ; // array[String] | Ip address of the host
        array[String] connectedNetworkDeviceIpAddress = ; // array[String] | Id of the network device to which host gets connected
        array[String] subType = ; // array[String] | UNKNOWN or IP_PHONE or TELEPRESENCE or VIDEO_SURVEILLANCE_IP_CAMERA or VIDEO_ENDPOINT
        String filterOperation = filterOperation_example; // String | startswith/contains/endswith
        try {
            HostOperation_HostListResult result = apiInstance.getHosts(limit, offset, sortBy, order, hostName, hostMac, hostType, connectedInterfaceName, hostIp, connectedNetworkDeviceIpAddress, subType, filterOperation);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling HostOperationApi#getHosts");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: auth_ticket)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Auth-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Auth-Token"];

String *limit = limit_example; // Limit (optional)
String *offset = offset_example; // Offset (optional)
String *sortBy = sortBy_example; // Sort by (optional)
String *order = order_example; // order (optional)
array[String] *hostName = ; // Host name (optional)
array[String] *hostMac = ; // Mac address of the host (optional)
array[String] *hostType = ; // Type of the host. Available options are Wired, Wireless (optional)
array[String] *connectedInterfaceName = ; // Name of the interface to which host gets connected (optional)
array[String] *hostIp = ; // Ip address of the host (optional)
array[String] *connectedNetworkDeviceIpAddress = ; // Id of the network device to which host gets connected (optional)
array[String] *subType = ; // UNKNOWN or IP_PHONE or TELEPRESENCE or VIDEO_SURVEILLANCE_IP_CAMERA or VIDEO_ENDPOINT (optional)
String *filterOperation = filterOperation_example; // startswith/contains/endswith (optional)

HostOperationApi *apiInstance = [[HostOperationApi alloc] init];

// Get Hosts
[apiInstance getHostsWith:limit
    offset:offset
    sortBy:sortBy
    order:order
    hostName:hostName
    hostMac:hostMac
    hostType:hostType
    connectedInterfaceName:connectedInterfaceName
    hostIp:hostIp
    connectedNetworkDeviceIpAddress:connectedNetworkDeviceIpAddress
    subType:subType
    filterOperation:filterOperation
              completionHandler: ^(HostOperation_HostListResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var CiscoPacketTracerNorthboundApiForNetworkControllerDevice = require('cisco_packet_tracer_northbound_api_for_network_controller_device');
var defaultClient = CiscoPacketTracerNorthboundApiForNetworkControllerDevice.ApiClient.instance;

// Configure API key authorization: auth_ticket
var auth_ticket = defaultClient.authentications['auth_ticket'];
auth_ticket.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//auth_ticket.apiKeyPrefix['X-Auth-Token'] = "Token"

var api = new CiscoPacketTracerNorthboundApiForNetworkControllerDevice.HostOperationApi()

var opts = { 
  'limit': limit_example, // {String} Limit
  'offset': offset_example, // {String} Offset
  'sortBy': sortBy_example, // {String} Sort by
  'order': order_example, // {String} order
  'hostName': , // {array[String]} Host name
  'hostMac': , // {array[String]} Mac address of the host
  'hostType': , // {array[String]} Type of the host. Available options are Wired, Wireless
  'connectedInterfaceName': , // {array[String]} Name of the interface to which host gets connected
  'hostIp': , // {array[String]} Ip address of the host
  'connectedNetworkDeviceIpAddress': , // {array[String]} Id of the network device to which host gets connected
  'subType': , // {array[String]} UNKNOWN or IP_PHONE or TELEPRESENCE or VIDEO_SURVEILLANCE_IP_CAMERA or VIDEO_ENDPOINT
  'filterOperation': filterOperation_example // {String} startswith/contains/endswith
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getHosts(opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getHostsExample
    {
        public void main()
        {
            
            // Configure API key authorization: auth_ticket
            Configuration.Default.ApiKey.Add("X-Auth-Token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Auth-Token", "Bearer");

            var apiInstance = new HostOperationApi();
            var limit = limit_example;  // String | Limit (optional) 
            var offset = offset_example;  // String | Offset (optional) 
            var sortBy = sortBy_example;  // String | Sort by (optional) 
            var order = order_example;  // String | order (optional) 
            var hostName = new array[String](); // array[String] | Host name (optional) 
            var hostMac = new array[String](); // array[String] | Mac address of the host (optional) 
            var hostType = new array[String](); // array[String] | Type of the host. Available options are Wired, Wireless (optional) 
            var connectedInterfaceName = new array[String](); // array[String] | Name of the interface to which host gets connected (optional) 
            var hostIp = new array[String](); // array[String] | Ip address of the host (optional) 
            var connectedNetworkDeviceIpAddress = new array[String](); // array[String] | Id of the network device to which host gets connected (optional) 
            var subType = new array[String](); // array[String] | UNKNOWN or IP_PHONE or TELEPRESENCE or VIDEO_SURVEILLANCE_IP_CAMERA or VIDEO_ENDPOINT (optional) 
            var filterOperation = filterOperation_example;  // String | startswith/contains/endswith (optional) 

            try
            {
                // Get Hosts
                HostOperation_HostListResult result = apiInstance.getHosts(limit, offset, sortBy, order, hostName, hostMac, hostType, connectedInterfaceName, hostIp, connectedNetworkDeviceIpAddress, subType, filterOperation);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling HostOperationApi.getHosts: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: auth_ticket
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');

$api_instance = new Swagger\Client\Api\HostOperationApi();
$limit = limit_example; // String | Limit
$offset = offset_example; // String | Offset
$sortBy = sortBy_example; // String | Sort by
$order = order_example; // String | order
$hostName = ; // array[String] | Host name
$hostMac = ; // array[String] | Mac address of the host
$hostType = ; // array[String] | Type of the host. Available options are Wired, Wireless
$connectedInterfaceName = ; // array[String] | Name of the interface to which host gets connected
$hostIp = ; // array[String] | Ip address of the host
$connectedNetworkDeviceIpAddress = ; // array[String] | Id of the network device to which host gets connected
$subType = ; // array[String] | UNKNOWN or IP_PHONE or TELEPRESENCE or VIDEO_SURVEILLANCE_IP_CAMERA or VIDEO_ENDPOINT
$filterOperation = filterOperation_example; // String | startswith/contains/endswith

try {
    $result = $api_instance->getHosts($limit, $offset, $sortBy, $order, $hostName, $hostMac, $hostType, $connectedInterfaceName, $hostIp, $connectedNetworkDeviceIpAddress, $subType, $filterOperation);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling HostOperationApi->getHosts: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::HostOperationApi;

# Configure API key authorization: auth_ticket
$WWW::SwaggerClient::Configuration::api_key->{'X-Auth-Token'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Auth-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::HostOperationApi->new();
my $limit = limit_example; # String | Limit
my $offset = offset_example; # String | Offset
my $sortBy = sortBy_example; # String | Sort by
my $order = order_example; # String | order
my $hostName = []; # array[String] | Host name
my $hostMac = []; # array[String] | Mac address of the host
my $hostType = []; # array[String] | Type of the host. Available options are Wired, Wireless
my $connectedInterfaceName = []; # array[String] | Name of the interface to which host gets connected
my $hostIp = []; # array[String] | Ip address of the host
my $connectedNetworkDeviceIpAddress = []; # array[String] | Id of the network device to which host gets connected
my $subType = []; # array[String] | UNKNOWN or IP_PHONE or TELEPRESENCE or VIDEO_SURVEILLANCE_IP_CAMERA or VIDEO_ENDPOINT
my $filterOperation = filterOperation_example; # String | startswith/contains/endswith

eval { 
    my $result = $api_instance->getHosts(limit => $limit, offset => $offset, sortBy => $sortBy, order => $order, hostName => $hostName, hostMac => $hostMac, hostType => $hostType, connectedInterfaceName => $connectedInterfaceName, hostIp => $hostIp, connectedNetworkDeviceIpAddress => $connectedNetworkDeviceIpAddress, subType => $subType, filterOperation => $filterOperation);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling HostOperationApi->getHosts: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: auth_ticket
swagger_client.configuration.api_key['X-Auth-Token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Auth-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.HostOperationApi()
limit = limit_example # String | Limit (optional)
offset = offset_example # String | Offset (optional)
sortBy = sortBy_example # String | Sort by (optional)
order = order_example # String | order (optional)
hostName =  # array[String] | Host name (optional)
hostMac =  # array[String] | Mac address of the host (optional)
hostType =  # array[String] | Type of the host. Available options are Wired, Wireless (optional)
connectedInterfaceName =  # array[String] | Name of the interface to which host gets connected (optional)
hostIp =  # array[String] | Ip address of the host (optional)
connectedNetworkDeviceIpAddress =  # array[String] | Id of the network device to which host gets connected (optional)
subType =  # array[String] | UNKNOWN or IP_PHONE or TELEPRESENCE or VIDEO_SURVEILLANCE_IP_CAMERA or VIDEO_ENDPOINT (optional)
filterOperation = filterOperation_example # String | startswith/contains/endswith (optional)


try: 
    # Get Hosts
    api_response = api_instance.get_hosts(limit=limit, offset=offset, sortBy=sortBy, order=order, hostName=hostName, hostMac=hostMac, hostType=hostType, connectedInterfaceName=connectedInterfaceName, hostIp=hostIp, connectedNetworkDeviceIpAddress=connectedNetworkDeviceIpAddress, subType=subType, filterOperation=filterOperation)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling HostOperationApi->getHosts: %s\n" % e)

Parameters

Query parameters

Name	Description
limit	String Limit
offset	String Offset
sortBy	String Sort by
order	String order
hostName	array[String] Host name
hostMac	array[String] Mac address of the host
hostType	array[String] Type of the host. Available options are Wired, Wireless
connectedInterfaceName	array[String] Name of the interface to which host gets connected
hostIp	array[String] Ip address of the host
connectedNetworkDeviceIpAddress	array[String] Id of the network device to which host gets connected
subType	array[String] UNKNOWN or IP_PHONE or TELEPRESENCE or VIDEO_SURVEILLANCE_IP_CAMERA or VIDEO_ENDPOINT
filterOperation	String startswith/contains/endswith

Responses

Status: 200 - The request was successful. The result is contained in the response body.

Schema

Status: 401 - The server recognizes the authentication credentials, but the client is not authorized to perform this request.

Status: 500 - The server could not fulfill the request.

Status: 501 - The server has not implemented the functionality required to fulfill the request.

Global Crendentials API

addCliCredential

Creates global CLI credential

This method is used to add global CLI credential

/global-credential/cli

Usage and SDK Samples

Curl

curl -X POST -H "X-Auth-Token: [[apiKey]]" "http://{IP}:{PORT}/api/v1/global-credential/cli"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GlobalCredentialApi;

import java.io.File;
import java.util.*;

public class GlobalCredentialApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: auth_ticket
        ApiKeyAuth auth_ticket = (ApiKeyAuth) defaultClient.getAuthentication("auth_ticket");
        auth_ticket.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //auth_ticket.setApiKeyPrefix("Token");

        GlobalCredentialApi apiInstance = new GlobalCredentialApi();
        CLICredentialDTO cLICredentialDTO = ; // CLICredentialDTO | CLI credentials
        try {
            Common_BooleanResponse result = apiInstance.addCliCredential(cLICredentialDTO);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GlobalCredentialApi#addCliCredential");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.GlobalCredentialApi;

public class GlobalCredentialApiExample {

    public static void main(String[] args) {
        GlobalCredentialApi apiInstance = new GlobalCredentialApi();
        CLICredentialDTO cLICredentialDTO = ; // CLICredentialDTO | CLI credentials
        try {
            Common_BooleanResponse result = apiInstance.addCliCredential(cLICredentialDTO);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GlobalCredentialApi#addCliCredential");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: auth_ticket)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Auth-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Auth-Token"];

CLICredentialDTO *cLICredentialDTO = ; // CLI credentials

GlobalCredentialApi *apiInstance = [[GlobalCredentialApi alloc] init];

// Creates global CLI credential
[apiInstance addCliCredentialWith:cLICredentialDTO
              completionHandler: ^(Common_BooleanResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var CiscoPacketTracerNorthboundApiForNetworkControllerDevice = require('cisco_packet_tracer_northbound_api_for_network_controller_device');
var defaultClient = CiscoPacketTracerNorthboundApiForNetworkControllerDevice.ApiClient.instance;

// Configure API key authorization: auth_ticket
var auth_ticket = defaultClient.authentications['auth_ticket'];
auth_ticket.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//auth_ticket.apiKeyPrefix['X-Auth-Token'] = "Token"

var api = new CiscoPacketTracerNorthboundApiForNetworkControllerDevice.GlobalCredentialApi()

var cLICredentialDTO = ; // {CLICredentialDTO} CLI credentials


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.addCliCredential(cLICredentialDTO, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class addCliCredentialExample
    {
        public void main()
        {
            
            // Configure API key authorization: auth_ticket
            Configuration.Default.ApiKey.Add("X-Auth-Token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Auth-Token", "Bearer");

            var apiInstance = new GlobalCredentialApi();
            var cLICredentialDTO = new CLICredentialDTO(); // CLICredentialDTO | CLI credentials

            try
            {
                // Creates global CLI credential
                Common_BooleanResponse result = apiInstance.addCliCredential(cLICredentialDTO);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GlobalCredentialApi.addCliCredential: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: auth_ticket
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');

$api_instance = new Swagger\Client\Api\GlobalCredentialApi();
$cLICredentialDTO = ; // CLICredentialDTO | CLI credentials

try {
    $result = $api_instance->addCliCredential($cLICredentialDTO);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GlobalCredentialApi->addCliCredential: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::GlobalCredentialApi;

# Configure API key authorization: auth_ticket
$WWW::SwaggerClient::Configuration::api_key->{'X-Auth-Token'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Auth-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::GlobalCredentialApi->new();
my $cLICredentialDTO = WWW::SwaggerClient::Object::CLICredentialDTO->new(); # CLICredentialDTO | CLI credentials

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

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: auth_ticket
swagger_client.configuration.api_key['X-Auth-Token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Auth-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.GlobalCredentialApi()
cLICredentialDTO =  # CLICredentialDTO | CLI credentials


try: 
    # Creates global CLI credential
    api_response = api_instance.add_cli_credential(cLICredentialDTO)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GlobalCredentialApi->addCliCredential: %s\n" % e)

Parameters

Body parameters

Name	Description
cLICredentialDTO *

Responses

Status: 200 - success

Schema

Status: 201 - The POST request was fulfilled and a new resource has been created. Information about the resource is in the response body.

Status: 401 - Not Authorized Yet, Credentials to be supplied

Status: 500 - The server could not fulfill the request.

Status: 501 - The server has not implemented the functionality required to fulfill the request.

deleteGlobalCredential

Retrieves global credential by ID

This method is used to delete global credential for the given ID

/global-credential/{globalCredentialId}

Usage and SDK Samples

Curl

curl -X DELETE -H "X-Auth-Token: [[apiKey]]" "http://{IP}:{PORT}/api/v1/global-credential/{globalCredentialId}"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GlobalCredentialApi;

import java.io.File;
import java.util.*;

public class GlobalCredentialApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: auth_ticket
        ApiKeyAuth auth_ticket = (ApiKeyAuth) defaultClient.getAuthentication("auth_ticket");
        auth_ticket.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //auth_ticket.setApiKeyPrefix("Token");

        GlobalCredentialApi apiInstance = new GlobalCredentialApi();
        String globalCredentialId = globalCredentialId_example; // String | ID of global-credential
        try {
            Common_BooleanResponse result = apiInstance.deleteGlobalCredential(globalCredentialId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GlobalCredentialApi#deleteGlobalCredential");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.GlobalCredentialApi;

public class GlobalCredentialApiExample {

    public static void main(String[] args) {
        GlobalCredentialApi apiInstance = new GlobalCredentialApi();
        String globalCredentialId = globalCredentialId_example; // String | ID of global-credential
        try {
            Common_BooleanResponse result = apiInstance.deleteGlobalCredential(globalCredentialId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GlobalCredentialApi#deleteGlobalCredential");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: auth_ticket)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Auth-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Auth-Token"];

String *globalCredentialId = globalCredentialId_example; // ID of global-credential

GlobalCredentialApi *apiInstance = [[GlobalCredentialApi alloc] init];

// Retrieves global credential by ID
[apiInstance deleteGlobalCredentialWith:globalCredentialId
              completionHandler: ^(Common_BooleanResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var CiscoPacketTracerNorthboundApiForNetworkControllerDevice = require('cisco_packet_tracer_northbound_api_for_network_controller_device');
var defaultClient = CiscoPacketTracerNorthboundApiForNetworkControllerDevice.ApiClient.instance;

// Configure API key authorization: auth_ticket
var auth_ticket = defaultClient.authentications['auth_ticket'];
auth_ticket.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//auth_ticket.apiKeyPrefix['X-Auth-Token'] = "Token"

var api = new CiscoPacketTracerNorthboundApiForNetworkControllerDevice.GlobalCredentialApi()

var globalCredentialId = globalCredentialId_example; // {String} ID of global-credential


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteGlobalCredential(globalCredentialId, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteGlobalCredentialExample
    {
        public void main()
        {
            
            // Configure API key authorization: auth_ticket
            Configuration.Default.ApiKey.Add("X-Auth-Token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Auth-Token", "Bearer");

            var apiInstance = new GlobalCredentialApi();
            var globalCredentialId = globalCredentialId_example;  // String | ID of global-credential

            try
            {
                // Retrieves global credential by ID
                Common_BooleanResponse result = apiInstance.deleteGlobalCredential(globalCredentialId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GlobalCredentialApi.deleteGlobalCredential: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: auth_ticket
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');

$api_instance = new Swagger\Client\Api\GlobalCredentialApi();
$globalCredentialId = globalCredentialId_example; // String | ID of global-credential

try {
    $result = $api_instance->deleteGlobalCredential($globalCredentialId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GlobalCredentialApi->deleteGlobalCredential: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::GlobalCredentialApi;

# Configure API key authorization: auth_ticket
$WWW::SwaggerClient::Configuration::api_key->{'X-Auth-Token'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Auth-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::GlobalCredentialApi->new();
my $globalCredentialId = globalCredentialId_example; # String | ID of global-credential

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

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: auth_ticket
swagger_client.configuration.api_key['X-Auth-Token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Auth-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.GlobalCredentialApi()
globalCredentialId = globalCredentialId_example # String | ID of global-credential


try: 
    # Retrieves global credential by ID
    api_response = api_instance.delete_global_credential(globalCredentialId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GlobalCredentialApi->deleteGlobalCredential: %s\n" % e)

Parameters

Path parameters

Name	Description
globalCredentialId*	String ID of global-credential Required

Responses

Status: 200 - success

Schema

Status: 401 - Not Authorized Yet, Credentials to be supplied

Status: 404 - No Resource Found

Status: 500 - The server could not fulfill the request.

Status: 501 - The server has not implemented the functionality required to fulfill the request.

getCliCredential

Retrieves global credential for cli

This method is used to get global credential for cli

/global-credential/cli

Usage and SDK Samples

Curl

curl -X GET -H "X-Auth-Token: [[apiKey]]" "http://{IP}:{PORT}/api/v1/global-credential/cli"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GlobalCredentialApi;

import java.io.File;
import java.util.*;

public class GlobalCredentialApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: auth_ticket
        ApiKeyAuth auth_ticket = (ApiKeyAuth) defaultClient.getAuthentication("auth_ticket");
        auth_ticket.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //auth_ticket.setApiKeyPrefix("Token");

        GlobalCredentialApi apiInstance = new GlobalCredentialApi();
        try {
            CLICredentialDTO result = apiInstance.getCliCredential();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GlobalCredentialApi#getCliCredential");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.GlobalCredentialApi;

public class GlobalCredentialApiExample {

    public static void main(String[] args) {
        GlobalCredentialApi apiInstance = new GlobalCredentialApi();
        try {
            CLICredentialDTO result = apiInstance.getCliCredential();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GlobalCredentialApi#getCliCredential");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: auth_ticket)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Auth-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Auth-Token"];


GlobalCredentialApi *apiInstance = [[GlobalCredentialApi alloc] init];

// Retrieves global credential for cli
[apiInstance getCliCredentialWithCompletionHandler: 
              ^(CLICredentialDTO output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var CiscoPacketTracerNorthboundApiForNetworkControllerDevice = require('cisco_packet_tracer_northbound_api_for_network_controller_device');
var defaultClient = CiscoPacketTracerNorthboundApiForNetworkControllerDevice.ApiClient.instance;

// Configure API key authorization: auth_ticket
var auth_ticket = defaultClient.authentications['auth_ticket'];
auth_ticket.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//auth_ticket.apiKeyPrefix['X-Auth-Token'] = "Token"

var api = new CiscoPacketTracerNorthboundApiForNetworkControllerDevice.GlobalCredentialApi()

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCliCredential(callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getCliCredentialExample
    {
        public void main()
        {
            
            // Configure API key authorization: auth_ticket
            Configuration.Default.ApiKey.Add("X-Auth-Token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Auth-Token", "Bearer");

            var apiInstance = new GlobalCredentialApi();

            try
            {
                // Retrieves global credential for cli
                CLICredentialDTO result = apiInstance.getCliCredential();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GlobalCredentialApi.getCliCredential: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: auth_ticket
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');

$api_instance = new Swagger\Client\Api\GlobalCredentialApi();

try {
    $result = $api_instance->getCliCredential();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GlobalCredentialApi->getCliCredential: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::GlobalCredentialApi;

# Configure API key authorization: auth_ticket
$WWW::SwaggerClient::Configuration::api_key->{'X-Auth-Token'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Auth-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::GlobalCredentialApi->new();

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

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: auth_ticket
swagger_client.configuration.api_key['X-Auth-Token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Auth-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.GlobalCredentialApi()


try: 
    # Retrieves global credential for cli
    api_response = api_instance.get_cli_credential()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GlobalCredentialApi->getCliCredential: %s\n" % e)

Parameters

Responses

Status: 200 - success

Schema

Status: 401 - Not Authorized Yet, Credentials to be supplied

Status: 500 - The server could not fulfill the request.

Status: 501 - The server has not implemented the functionality required to fulfill the request.

getGlobalCredentialSubTypeByID

Retrieves credential sub type for the given credential Id

This method is used to get credential sub type for the given Id

/global-credential/{id}

Usage and SDK Samples

Curl

curl -X GET -H "X-Auth-Token: [[apiKey]]" "http://{IP}:{PORT}/api/v1/global-credential/{id}"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GlobalCredentialApi;

import java.io.File;
import java.util.*;

public class GlobalCredentialApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: auth_ticket
        ApiKeyAuth auth_ticket = (ApiKeyAuth) defaultClient.getAuthentication("auth_ticket");
        auth_ticket.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //auth_ticket.setApiKeyPrefix("Token");

        GlobalCredentialApi apiInstance = new GlobalCredentialApi();
        String id = id_example; // String | Global Credential ID
        try {
            GlobalCredentialSubTypeResult result = apiInstance.getGlobalCredentialSubTypeByID(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GlobalCredentialApi#getGlobalCredentialSubTypeByID");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.GlobalCredentialApi;

public class GlobalCredentialApiExample {

    public static void main(String[] args) {
        GlobalCredentialApi apiInstance = new GlobalCredentialApi();
        String id = id_example; // String | Global Credential ID
        try {
            GlobalCredentialSubTypeResult result = apiInstance.getGlobalCredentialSubTypeByID(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GlobalCredentialApi#getGlobalCredentialSubTypeByID");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: auth_ticket)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Auth-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Auth-Token"];

String *id = id_example; // Global Credential ID

GlobalCredentialApi *apiInstance = [[GlobalCredentialApi alloc] init];

// Retrieves credential sub type for the given credential Id
[apiInstance getGlobalCredentialSubTypeByIDWith:id
              completionHandler: ^(GlobalCredentialSubTypeResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var CiscoPacketTracerNorthboundApiForNetworkControllerDevice = require('cisco_packet_tracer_northbound_api_for_network_controller_device');
var defaultClient = CiscoPacketTracerNorthboundApiForNetworkControllerDevice.ApiClient.instance;

// Configure API key authorization: auth_ticket
var auth_ticket = defaultClient.authentications['auth_ticket'];
auth_ticket.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//auth_ticket.apiKeyPrefix['X-Auth-Token'] = "Token"

var api = new CiscoPacketTracerNorthboundApiForNetworkControllerDevice.GlobalCredentialApi()

var id = id_example; // {String} Global Credential ID


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getGlobalCredentialSubTypeByID(id, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getGlobalCredentialSubTypeByIDExample
    {
        public void main()
        {
            
            // Configure API key authorization: auth_ticket
            Configuration.Default.ApiKey.Add("X-Auth-Token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Auth-Token", "Bearer");

            var apiInstance = new GlobalCredentialApi();
            var id = id_example;  // String | Global Credential ID

            try
            {
                // Retrieves credential sub type for the given credential Id
                GlobalCredentialSubTypeResult result = apiInstance.getGlobalCredentialSubTypeByID(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GlobalCredentialApi.getGlobalCredentialSubTypeByID: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: auth_ticket
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');

$api_instance = new Swagger\Client\Api\GlobalCredentialApi();
$id = id_example; // String | Global Credential ID

try {
    $result = $api_instance->getGlobalCredentialSubTypeByID($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GlobalCredentialApi->getGlobalCredentialSubTypeByID: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::GlobalCredentialApi;

# Configure API key authorization: auth_ticket
$WWW::SwaggerClient::Configuration::api_key->{'X-Auth-Token'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Auth-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::GlobalCredentialApi->new();
my $id = id_example; # String | Global Credential ID

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

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: auth_ticket
swagger_client.configuration.api_key['X-Auth-Token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Auth-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.GlobalCredentialApi()
id = id_example # String | Global Credential ID


try: 
    # Retrieves credential sub type for the given credential Id
    api_response = api_instance.get_global_credential_sub_type_by_id(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GlobalCredentialApi->getGlobalCredentialSubTypeByID: %s\n" % e)

Parameters

Path parameters

Name	Description
id*	String Global Credential ID Required

Responses

Status: 200 - success

Schema

Status: 401 - Not Authorized Yet, Credentials to be supplied

Status: 404 - No Resource Found

Status: 500 - The server could not fulfill the request.

Status: 501 - The server has not implemented the functionality required to fulfill the request.

updateCliCredential

Updates global CLI credential

This method is used to update global CLI credential

/global-credential/cli

Usage and SDK Samples

Curl

curl -X PUT -H "X-Auth-Token: [[apiKey]]" "http://{IP}:{PORT}/api/v1/global-credential/cli"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GlobalCredentialApi;

import java.io.File;
import java.util.*;

public class GlobalCredentialApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: auth_ticket
        ApiKeyAuth auth_ticket = (ApiKeyAuth) defaultClient.getAuthentication("auth_ticket");
        auth_ticket.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //auth_ticket.setApiKeyPrefix("Token");

        GlobalCredentialApi apiInstance = new GlobalCredentialApi();
        CLICredentialDTO globalCredentialNio = ; // CLICredentialDTO | CLI credentials
        try {
            Common_BooleanResponse result = apiInstance.updateCliCredential(globalCredentialNio);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GlobalCredentialApi#updateCliCredential");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.GlobalCredentialApi;

public class GlobalCredentialApiExample {

    public static void main(String[] args) {
        GlobalCredentialApi apiInstance = new GlobalCredentialApi();
        CLICredentialDTO globalCredentialNio = ; // CLICredentialDTO | CLI credentials
        try {
            Common_BooleanResponse result = apiInstance.updateCliCredential(globalCredentialNio);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GlobalCredentialApi#updateCliCredential");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: auth_ticket)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Auth-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Auth-Token"];

CLICredentialDTO *globalCredentialNio = ; // CLI credentials

GlobalCredentialApi *apiInstance = [[GlobalCredentialApi alloc] init];

// Updates global CLI credential
[apiInstance updateCliCredentialWith:globalCredentialNio
              completionHandler: ^(Common_BooleanResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var CiscoPacketTracerNorthboundApiForNetworkControllerDevice = require('cisco_packet_tracer_northbound_api_for_network_controller_device');
var defaultClient = CiscoPacketTracerNorthboundApiForNetworkControllerDevice.ApiClient.instance;

// Configure API key authorization: auth_ticket
var auth_ticket = defaultClient.authentications['auth_ticket'];
auth_ticket.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//auth_ticket.apiKeyPrefix['X-Auth-Token'] = "Token"

var api = new CiscoPacketTracerNorthboundApiForNetworkControllerDevice.GlobalCredentialApi()

var globalCredentialNio = ; // {CLICredentialDTO} CLI credentials


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateCliCredential(globalCredentialNio, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateCliCredentialExample
    {
        public void main()
        {
            
            // Configure API key authorization: auth_ticket
            Configuration.Default.ApiKey.Add("X-Auth-Token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Auth-Token", "Bearer");

            var apiInstance = new GlobalCredentialApi();
            var globalCredentialNio = new CLICredentialDTO(); // CLICredentialDTO | CLI credentials

            try
            {
                // Updates global CLI credential
                Common_BooleanResponse result = apiInstance.updateCliCredential(globalCredentialNio);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GlobalCredentialApi.updateCliCredential: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: auth_ticket
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');

$api_instance = new Swagger\Client\Api\GlobalCredentialApi();
$globalCredentialNio = ; // CLICredentialDTO | CLI credentials

try {
    $result = $api_instance->updateCliCredential($globalCredentialNio);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GlobalCredentialApi->updateCliCredential: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::GlobalCredentialApi;

# Configure API key authorization: auth_ticket
$WWW::SwaggerClient::Configuration::api_key->{'X-Auth-Token'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Auth-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::GlobalCredentialApi->new();
my $globalCredentialNio = WWW::SwaggerClient::Object::CLICredentialDTO->new(); # CLICredentialDTO | CLI credentials

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

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: auth_ticket
swagger_client.configuration.api_key['X-Auth-Token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Auth-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.GlobalCredentialApi()
globalCredentialNio =  # CLICredentialDTO | CLI credentials


try: 
    # Updates global CLI credential
    api_response = api_instance.update_cli_credential(globalCredentialNio)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GlobalCredentialApi->updateCliCredential: %s\n" % e)

Parameters

Body parameters

Name	Description
globalCredentialNio *

Responses

Status: 200 - success

Schema

Status: 401 - Not Authorized Yet, Credentials to be supplied

Status: 404 - No Resource Found

Status: 500 - The server could not fulfill the request.

Status: 501 - The server has not implemented the functionality required to fulfill the request.

Assurance API

getAllNetworkIssues

All Network Health Issues

Get all network health issues

/assurance/health-issues

Usage and SDK Samples

Curl

curl -X GET -H "X-Auth-Token: [[apiKey]]" "http://{IP}:{PORT}/api/v1/assurance/health-issues"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AssuranceApi;

import java.io.File;
import java.util.*;

public class AssuranceApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: auth_ticket
        ApiKeyAuth auth_ticket = (ApiKeyAuth) defaultClient.getAuthentication("auth_ticket");
        auth_ticket.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //auth_ticket.setApiKeyPrefix("Token");

        AssuranceApi apiInstance = new AssuranceApi();
        try {
            Assurance_HealthIssues result = apiInstance.getAllNetworkIssues();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AssuranceApi#getAllNetworkIssues");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.AssuranceApi;

public class AssuranceApiExample {

    public static void main(String[] args) {
        AssuranceApi apiInstance = new AssuranceApi();
        try {
            Assurance_HealthIssues result = apiInstance.getAllNetworkIssues();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AssuranceApi#getAllNetworkIssues");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: auth_ticket)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Auth-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Auth-Token"];


AssuranceApi *apiInstance = [[AssuranceApi alloc] init];

// All Network Health Issues
[apiInstance getAllNetworkIssuesWithCompletionHandler: 
              ^(Assurance_HealthIssues output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var CiscoPacketTracerNorthboundApiForNetworkControllerDevice = require('cisco_packet_tracer_northbound_api_for_network_controller_device');
var defaultClient = CiscoPacketTracerNorthboundApiForNetworkControllerDevice.ApiClient.instance;

// Configure API key authorization: auth_ticket
var auth_ticket = defaultClient.authentications['auth_ticket'];
auth_ticket.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//auth_ticket.apiKeyPrefix['X-Auth-Token'] = "Token"

var api = new CiscoPacketTracerNorthboundApiForNetworkControllerDevice.AssuranceApi()

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAllNetworkIssues(callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAllNetworkIssuesExample
    {
        public void main()
        {
            
            // Configure API key authorization: auth_ticket
            Configuration.Default.ApiKey.Add("X-Auth-Token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Auth-Token", "Bearer");

            var apiInstance = new AssuranceApi();

            try
            {
                // All Network Health Issues
                Assurance_HealthIssues result = apiInstance.getAllNetworkIssues();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AssuranceApi.getAllNetworkIssues: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: auth_ticket
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');

$api_instance = new Swagger\Client\Api\AssuranceApi();

try {
    $result = $api_instance->getAllNetworkIssues();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AssuranceApi->getAllNetworkIssues: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AssuranceApi;

# Configure API key authorization: auth_ticket
$WWW::SwaggerClient::Configuration::api_key->{'X-Auth-Token'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Auth-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AssuranceApi->new();

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

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: auth_ticket
swagger_client.configuration.api_key['X-Auth-Token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Auth-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AssuranceApi()


try: 
    # All Network Health Issues
    api_response = api_instance.get_all_network_issues()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AssuranceApi->getAllNetworkIssues: %s\n" % e)

Parameters

Responses

Status: 200 - The request was successful. The result is contained in the response body.

Schema

Status: 401 - Not Authorized Yet, Credentials to be supplied

Status: 500 - The server could not fulfill the request.

Status: 501 - The server has not implemented the functionality required to fulfill the request.

getNetworkHealth

Overall Network Health

Returns Overall Network Health information by Device category (Router, Switch, Host) for any given point of time

/assurance/health

Usage and SDK Samples

Curl

curl -X GET -H "X-Auth-Token: [[apiKey]]" "http://{IP}:{PORT}/api/v1/assurance/health"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AssuranceApi;

import java.io.File;
import java.util.*;

public class AssuranceApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: auth_ticket
        ApiKeyAuth auth_ticket = (ApiKeyAuth) defaultClient.getAuthentication("auth_ticket");
        auth_ticket.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //auth_ticket.setApiKeyPrefix("Token");

        AssuranceApi apiInstance = new AssuranceApi();
        try {
            Assurance_Health result = apiInstance.getNetworkHealth();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AssuranceApi#getNetworkHealth");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.AssuranceApi;

public class AssuranceApiExample {

    public static void main(String[] args) {
        AssuranceApi apiInstance = new AssuranceApi();
        try {
            Assurance_Health result = apiInstance.getNetworkHealth();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AssuranceApi#getNetworkHealth");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: auth_ticket)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Auth-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Auth-Token"];


AssuranceApi *apiInstance = [[AssuranceApi alloc] init];

// Overall Network Health
[apiInstance getNetworkHealthWithCompletionHandler: 
              ^(Assurance_Health output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var CiscoPacketTracerNorthboundApiForNetworkControllerDevice = require('cisco_packet_tracer_northbound_api_for_network_controller_device');
var defaultClient = CiscoPacketTracerNorthboundApiForNetworkControllerDevice.ApiClient.instance;

// Configure API key authorization: auth_ticket
var auth_ticket = defaultClient.authentications['auth_ticket'];
auth_ticket.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//auth_ticket.apiKeyPrefix['X-Auth-Token'] = "Token"

var api = new CiscoPacketTracerNorthboundApiForNetworkControllerDevice.AssuranceApi()

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getNetworkHealth(callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getNetworkHealthExample
    {
        public void main()
        {
            
            // Configure API key authorization: auth_ticket
            Configuration.Default.ApiKey.Add("X-Auth-Token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Auth-Token", "Bearer");

            var apiInstance = new AssuranceApi();

            try
            {
                // Overall Network Health
                Assurance_Health result = apiInstance.getNetworkHealth();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AssuranceApi.getNetworkHealth: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: auth_ticket
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');

$api_instance = new Swagger\Client\Api\AssuranceApi();

try {
    $result = $api_instance->getNetworkHealth();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AssuranceApi->getNetworkHealth: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AssuranceApi;

# Configure API key authorization: auth_ticket
$WWW::SwaggerClient::Configuration::api_key->{'X-Auth-Token'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Auth-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AssuranceApi->new();

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

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: auth_ticket
swagger_client.configuration.api_key['X-Auth-Token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Auth-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AssuranceApi()


try: 
    # Overall Network Health
    api_response = api_instance.get_network_health()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AssuranceApi->getNetworkHealth: %s\n" % e)

Parameters

Responses

Status: 200 - The request was successful. The result is contained in the response body.

Schema

Status: 401 - Not Authorized Yet, Credentials to be supplied

Status: 500 - The server could not fulfill the request.

Status: 501 - The server has not implemented the functionality required to fulfill the request.

getNetworkIssue

Health Issue Detail

Get a health issue detail fron an ID

/assurance/health/{id}

Usage and SDK Samples

Curl

curl -X GET -H "X-Auth-Token: [[apiKey]]" "http://{IP}:{PORT}/api/v1/assurance/health/{id}"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AssuranceApi;

import java.io.File;
import java.util.*;

public class AssuranceApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: auth_ticket
        ApiKeyAuth auth_ticket = (ApiKeyAuth) defaultClient.getAuthentication("auth_ticket");
        auth_ticket.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //auth_ticket.setApiKeyPrefix("Token");

        AssuranceApi apiInstance = new AssuranceApi();
        String id = id_example; // String | Issue details can be fetched based on Issue ID. This parameter value must either be an issue_id.
        try {
            Assurance_HealthIssue result = apiInstance.getNetworkIssue(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AssuranceApi#getNetworkIssue");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.AssuranceApi;

public class AssuranceApiExample {

    public static void main(String[] args) {
        AssuranceApi apiInstance = new AssuranceApi();
        String id = id_example; // String | Issue details can be fetched based on Issue ID. This parameter value must either be an issue_id.
        try {
            Assurance_HealthIssue result = apiInstance.getNetworkIssue(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AssuranceApi#getNetworkIssue");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: auth_ticket)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Auth-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Auth-Token"];

String *id = id_example; // Issue details can be fetched based on Issue ID. This parameter value must either be an issue_id.

AssuranceApi *apiInstance = [[AssuranceApi alloc] init];

// Health Issue Detail
[apiInstance getNetworkIssueWith:id
              completionHandler: ^(Assurance_HealthIssue output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var CiscoPacketTracerNorthboundApiForNetworkControllerDevice = require('cisco_packet_tracer_northbound_api_for_network_controller_device');
var defaultClient = CiscoPacketTracerNorthboundApiForNetworkControllerDevice.ApiClient.instance;

// Configure API key authorization: auth_ticket
var auth_ticket = defaultClient.authentications['auth_ticket'];
auth_ticket.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//auth_ticket.apiKeyPrefix['X-Auth-Token'] = "Token"

var api = new CiscoPacketTracerNorthboundApiForNetworkControllerDevice.AssuranceApi()

var id = id_example; // {String} Issue details can be fetched based on Issue ID. This parameter value must either be an issue_id.


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getNetworkIssue(id, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getNetworkIssueExample
    {
        public void main()
        {
            
            // Configure API key authorization: auth_ticket
            Configuration.Default.ApiKey.Add("X-Auth-Token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Auth-Token", "Bearer");

            var apiInstance = new AssuranceApi();
            var id = id_example;  // String | Issue details can be fetched based on Issue ID. This parameter value must either be an issue_id.

            try
            {
                // Health Issue Detail
                Assurance_HealthIssue result = apiInstance.getNetworkIssue(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AssuranceApi.getNetworkIssue: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: auth_ticket
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');

$api_instance = new Swagger\Client\Api\AssuranceApi();
$id = id_example; // String | Issue details can be fetched based on Issue ID. This parameter value must either be an issue_id.

try {
    $result = $api_instance->getNetworkIssue($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AssuranceApi->getNetworkIssue: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AssuranceApi;

# Configure API key authorization: auth_ticket
$WWW::SwaggerClient::Configuration::api_key->{'X-Auth-Token'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Auth-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AssuranceApi->new();
my $id = id_example; # String | Issue details can be fetched based on Issue ID. This parameter value must either be an issue_id.

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

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: auth_ticket
swagger_client.configuration.api_key['X-Auth-Token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Auth-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AssuranceApi()
id = id_example # String | Issue details can be fetched based on Issue ID. This parameter value must either be an issue_id.


try: 
    # Health Issue Detail
    api_response = api_instance.get_network_issue(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AssuranceApi->getNetworkIssue: %s\n" % e)

Parameters

Path parameters

Name	Description
id*	String Issue details can be fetched based on Issue ID. This parameter value must either be an issue_id. Required

Responses

Status: 200 - The request was successful. The result is contained in the response body.

Schema

Status: 401 - Not Authorized Yet, Credentials to be supplied

Status: 404 - No Resource Found

Status: 500 - The server could not fulfill the request.

Status: 501 - The server has not implemented the functionality required to fulfill the request.

Dashboard API

getSiteHealth

Network Health

Returns Overall Health information for the network

/network-health

Usage and SDK Samples

Curl

curl -X GET -H "X-Auth-Token: [[apiKey]]" "http://{IP}:{PORT}/api/v1/network-health"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DashboardApi;

import java.io.File;
import java.util.*;

public class DashboardApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: auth_ticket
        ApiKeyAuth auth_ticket = (ApiKeyAuth) defaultClient.getAuthentication("auth_ticket");
        auth_ticket.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //auth_ticket.setApiKeyPrefix("Token");

        DashboardApi apiInstance = new DashboardApi();
        try {
            Dashboard_SiteHealth result = apiInstance.getSiteHealth();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DashboardApi#getSiteHealth");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.DashboardApi;

public class DashboardApiExample {

    public static void main(String[] args) {
        DashboardApi apiInstance = new DashboardApi();
        try {
            Dashboard_SiteHealth result = apiInstance.getSiteHealth();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DashboardApi#getSiteHealth");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: auth_ticket)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Auth-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Auth-Token"];


DashboardApi *apiInstance = [[DashboardApi alloc] init];

// Network Health
[apiInstance getSiteHealthWithCompletionHandler: 
              ^(Dashboard_SiteHealth output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var CiscoPacketTracerNorthboundApiForNetworkControllerDevice = require('cisco_packet_tracer_northbound_api_for_network_controller_device');
var defaultClient = CiscoPacketTracerNorthboundApiForNetworkControllerDevice.ApiClient.instance;

// Configure API key authorization: auth_ticket
var auth_ticket = defaultClient.authentications['auth_ticket'];
auth_ticket.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//auth_ticket.apiKeyPrefix['X-Auth-Token'] = "Token"

var api = new CiscoPacketTracerNorthboundApiForNetworkControllerDevice.DashboardApi()

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getSiteHealth(callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getSiteHealthExample
    {
        public void main()
        {
            
            // Configure API key authorization: auth_ticket
            Configuration.Default.ApiKey.Add("X-Auth-Token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Auth-Token", "Bearer");

            var apiInstance = new DashboardApi();

            try
            {
                // Network Health
                Dashboard_SiteHealth result = apiInstance.getSiteHealth();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DashboardApi.getSiteHealth: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: auth_ticket
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');

$api_instance = new Swagger\Client\Api\DashboardApi();

try {
    $result = $api_instance->getSiteHealth();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DashboardApi->getSiteHealth: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DashboardApi;

# Configure API key authorization: auth_ticket
$WWW::SwaggerClient::Configuration::api_key->{'X-Auth-Token'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Auth-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::DashboardApi->new();

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

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: auth_ticket
swagger_client.configuration.api_key['X-Auth-Token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Auth-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.DashboardApi()


try: 
    # Network Health
    api_response = api_instance.get_site_health()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DashboardApi->getSiteHealth: %s\n" % e)

Parameters

Responses

Status: 200 - The request was successful. The result is contained in the response body.

Schema

Status: 401 - Not Authorized Yet, Credentials to be supplied

Status: 500 - The server could not fulfill the request.

Status: 501 - The server has not implemented the functionality required to fulfill the request.

Discovery API

deleteAllDiscovery

Delete All Discovery

Stops all the discoveries and removes them

/discovery

Usage and SDK Samples

Curl

curl -X DELETE -H "X-Auth-Token: [[apiKey]]" "http://{IP}:{PORT}/api/v1/discovery"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DiscoveryApi;

import java.io.File;
import java.util.*;

public class DiscoveryApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: auth_ticket
        ApiKeyAuth auth_ticket = (ApiKeyAuth) defaultClient.getAuthentication("auth_ticket");
        auth_ticket.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //auth_ticket.setApiKeyPrefix("Token");

        DiscoveryApi apiInstance = new DiscoveryApi();
        try {
            Common_BooleanResponse result = apiInstance.deleteAllDiscovery();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DiscoveryApi#deleteAllDiscovery");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.DiscoveryApi;

public class DiscoveryApiExample {

    public static void main(String[] args) {
        DiscoveryApi apiInstance = new DiscoveryApi();
        try {
            Common_BooleanResponse result = apiInstance.deleteAllDiscovery();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DiscoveryApi#deleteAllDiscovery");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: auth_ticket)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Auth-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Auth-Token"];


DiscoveryApi *apiInstance = [[DiscoveryApi alloc] init];

// Delete All Discovery
[apiInstance deleteAllDiscoveryWithCompletionHandler: 
              ^(Common_BooleanResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var CiscoPacketTracerNorthboundApiForNetworkControllerDevice = require('cisco_packet_tracer_northbound_api_for_network_controller_device');
var defaultClient = CiscoPacketTracerNorthboundApiForNetworkControllerDevice.ApiClient.instance;

// Configure API key authorization: auth_ticket
var auth_ticket = defaultClient.authentications['auth_ticket'];
auth_ticket.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//auth_ticket.apiKeyPrefix['X-Auth-Token'] = "Token"

var api = new CiscoPacketTracerNorthboundApiForNetworkControllerDevice.DiscoveryApi()

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteAllDiscovery(callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteAllDiscoveryExample
    {
        public void main()
        {
            
            // Configure API key authorization: auth_ticket
            Configuration.Default.ApiKey.Add("X-Auth-Token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Auth-Token", "Bearer");

            var apiInstance = new DiscoveryApi();

            try
            {
                // Delete All Discovery
                Common_BooleanResponse result = apiInstance.deleteAllDiscovery();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DiscoveryApi.deleteAllDiscovery: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: auth_ticket
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');

$api_instance = new Swagger\Client\Api\DiscoveryApi();

try {
    $result = $api_instance->deleteAllDiscovery();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DiscoveryApi->deleteAllDiscovery: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DiscoveryApi;

# Configure API key authorization: auth_ticket
$WWW::SwaggerClient::Configuration::api_key->{'X-Auth-Token'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Auth-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::DiscoveryApi->new();

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

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: auth_ticket
swagger_client.configuration.api_key['X-Auth-Token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Auth-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.DiscoveryApi()


try: 
    # Delete All Discovery
    api_response = api_instance.delete_all_discovery()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DiscoveryApi->deleteAllDiscovery: %s\n" % e)

Parameters

Responses

Status: 200 - The request was successful. The result is contained in the response body.

Schema

Status: 401 - Not Authorized Yet, Credentials to be supplied

Status: 500 - The server could not fulfill the request.

Status: 501 - The server has not implemented the functionality required to fulfill the request.

deleteDiscoveryById

Deletes the discovery specified by id

Deletes discovery by ID

/discovery/{id}

Usage and SDK Samples

Curl

curl -X DELETE -H "X-Auth-Token: [[apiKey]]" "http://{IP}:{PORT}/api/v1/discovery/{id}"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DiscoveryApi;

import java.io.File;
import java.util.*;

public class DiscoveryApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: auth_ticket
        ApiKeyAuth auth_ticket = (ApiKeyAuth) defaultClient.getAuthentication("auth_ticket");
        auth_ticket.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //auth_ticket.setApiKeyPrefix("Token");

        DiscoveryApi apiInstance = new DiscoveryApi();
        String id = id_example; // String | Discovery id
        try {
            Common_BooleanResponse result = apiInstance.deleteDiscoveryById(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DiscoveryApi#deleteDiscoveryById");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.DiscoveryApi;

public class DiscoveryApiExample {

    public static void main(String[] args) {
        DiscoveryApi apiInstance = new DiscoveryApi();
        String id = id_example; // String | Discovery id
        try {
            Common_BooleanResponse result = apiInstance.deleteDiscoveryById(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DiscoveryApi#deleteDiscoveryById");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: auth_ticket)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Auth-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Auth-Token"];

String *id = id_example; // Discovery id

DiscoveryApi *apiInstance = [[DiscoveryApi alloc] init];

// Deletes the discovery specified by id
[apiInstance deleteDiscoveryByIdWith:id
              completionHandler: ^(Common_BooleanResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var CiscoPacketTracerNorthboundApiForNetworkControllerDevice = require('cisco_packet_tracer_northbound_api_for_network_controller_device');
var defaultClient = CiscoPacketTracerNorthboundApiForNetworkControllerDevice.ApiClient.instance;

// Configure API key authorization: auth_ticket
var auth_ticket = defaultClient.authentications['auth_ticket'];
auth_ticket.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//auth_ticket.apiKeyPrefix['X-Auth-Token'] = "Token"

var api = new CiscoPacketTracerNorthboundApiForNetworkControllerDevice.DiscoveryApi()

var id = id_example; // {String} Discovery id


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteDiscoveryById(id, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteDiscoveryByIdExample
    {
        public void main()
        {
            
            // Configure API key authorization: auth_ticket
            Configuration.Default.ApiKey.Add("X-Auth-Token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Auth-Token", "Bearer");

            var apiInstance = new DiscoveryApi();
            var id = id_example;  // String | Discovery id

            try
            {
                // Deletes the discovery specified by id
                Common_BooleanResponse result = apiInstance.deleteDiscoveryById(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DiscoveryApi.deleteDiscoveryById: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: auth_ticket
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');

$api_instance = new Swagger\Client\Api\DiscoveryApi();
$id = id_example; // String | Discovery id

try {
    $result = $api_instance->deleteDiscoveryById($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DiscoveryApi->deleteDiscoveryById: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DiscoveryApi;

# Configure API key authorization: auth_ticket
$WWW::SwaggerClient::Configuration::api_key->{'X-Auth-Token'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Auth-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::DiscoveryApi->new();
my $id = id_example; # String | Discovery id

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

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: auth_ticket
swagger_client.configuration.api_key['X-Auth-Token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Auth-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.DiscoveryApi()
id = id_example # String | Discovery id


try: 
    # Deletes the discovery specified by id
    api_response = api_instance.delete_discovery_by_id(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DiscoveryApi->deleteDiscoveryById: %s\n" % e)

Parameters

Path parameters

Name	Description
id*	String Discovery id Required

Responses

Status: 200 - The request was successful. The result is contained in the response body.

Schema

Status: 401 - Not Authorized Yet, Credentials to be supplied

Status: 404 - No Resource Found

Status: 500 - The server could not fulfill the request.

Status: 501 - The server has not implemented the functionality required to fulfill the request.

deleteDiscoveryByRange

Deletes the discovery in the given range

Stops discovery for the given range and removes them

/discovery/{startIndex}/{numRecords}

Usage and SDK Samples

Curl

curl -X DELETE -H "X-Auth-Token: [[apiKey]]" "http://{IP}:{PORT}/api/v1/discovery/{startIndex}/{numRecords}"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DiscoveryApi;

import java.io.File;
import java.util.*;

public class DiscoveryApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: auth_ticket
        ApiKeyAuth auth_ticket = (ApiKeyAuth) defaultClient.getAuthentication("auth_ticket");
        auth_ticket.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //auth_ticket.setApiKeyPrefix("Token");

        DiscoveryApi apiInstance = new DiscoveryApi();
        Integer startIndex = 56; // Integer | Start index [0-254]
        Integer numRecords = 56; // Integer | Number of records to delete
        try {
            Common_BooleanResponse result = apiInstance.deleteDiscoveryByRange(startIndex, numRecords);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DiscoveryApi#deleteDiscoveryByRange");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.DiscoveryApi;

public class DiscoveryApiExample {

    public static void main(String[] args) {
        DiscoveryApi apiInstance = new DiscoveryApi();
        Integer startIndex = 56; // Integer | Start index [0-254]
        Integer numRecords = 56; // Integer | Number of records to delete
        try {
            Common_BooleanResponse result = apiInstance.deleteDiscoveryByRange(startIndex, numRecords);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DiscoveryApi#deleteDiscoveryByRange");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: auth_ticket)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Auth-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Auth-Token"];

Integer *startIndex = 56; // Start index [0-254]
Integer *numRecords = 56; // Number of records to delete

DiscoveryApi *apiInstance = [[DiscoveryApi alloc] init];

// Deletes the discovery in the given range
[apiInstance deleteDiscoveryByRangeWith:startIndex
    numRecords:numRecords
              completionHandler: ^(Common_BooleanResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var CiscoPacketTracerNorthboundApiForNetworkControllerDevice = require('cisco_packet_tracer_northbound_api_for_network_controller_device');
var defaultClient = CiscoPacketTracerNorthboundApiForNetworkControllerDevice.ApiClient.instance;

// Configure API key authorization: auth_ticket
var auth_ticket = defaultClient.authentications['auth_ticket'];
auth_ticket.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//auth_ticket.apiKeyPrefix['X-Auth-Token'] = "Token"

var api = new CiscoPacketTracerNorthboundApiForNetworkControllerDevice.DiscoveryApi()

var startIndex = 56; // {Integer} Start index [0-254]

var numRecords = 56; // {Integer} Number of records to delete


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteDiscoveryByRange(startIndex, numRecords, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteDiscoveryByRangeExample
    {
        public void main()
        {
            
            // Configure API key authorization: auth_ticket
            Configuration.Default.ApiKey.Add("X-Auth-Token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Auth-Token", "Bearer");

            var apiInstance = new DiscoveryApi();
            var startIndex = 56;  // Integer | Start index [0-254]
            var numRecords = 56;  // Integer | Number of records to delete

            try
            {
                // Deletes the discovery in the given range
                Common_BooleanResponse result = apiInstance.deleteDiscoveryByRange(startIndex, numRecords);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DiscoveryApi.deleteDiscoveryByRange: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: auth_ticket
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');

$api_instance = new Swagger\Client\Api\DiscoveryApi();
$startIndex = 56; // Integer | Start index [0-254]
$numRecords = 56; // Integer | Number of records to delete

try {
    $result = $api_instance->deleteDiscoveryByRange($startIndex, $numRecords);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DiscoveryApi->deleteDiscoveryByRange: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DiscoveryApi;

# Configure API key authorization: auth_ticket
$WWW::SwaggerClient::Configuration::api_key->{'X-Auth-Token'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Auth-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::DiscoveryApi->new();
my $startIndex = 56; # Integer | Start index [0-254]
my $numRecords = 56; # Integer | Number of records to delete

eval { 
    my $result = $api_instance->deleteDiscoveryByRange(startIndex => $startIndex, numRecords => $numRecords);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DiscoveryApi->deleteDiscoveryByRange: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: auth_ticket
swagger_client.configuration.api_key['X-Auth-Token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Auth-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.DiscoveryApi()
startIndex = 56 # Integer | Start index [0-254]
numRecords = 56 # Integer | Number of records to delete


try: 
    # Deletes the discovery in the given range
    api_response = api_instance.delete_discovery_by_range(startIndex, numRecords)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DiscoveryApi->deleteDiscoveryByRange: %s\n" % e)

Parameters

Path parameters

Name	Description
startIndex*	Integer Start index [0-254] Required
numRecords*	Integer Number of records to delete Required

Responses

Status: 200 - The request was successful. The result is contained in the response body.

Schema

Status: 400 - The client made a request that the server could not understand (for example, the request syntax is incorrect).

Status: 401 - Not Authorized Yet, Credentials to be supplied

Status: 500 - The server could not fulfill the request.

Status: 501 - The server has not implemented the functionality required to fulfill the request.

getDiscovery

Retrieves all the discoveries

Gets all the discoveries

/discovery

Usage and SDK Samples

Curl

curl -X GET -H "X-Auth-Token: [[apiKey]]" "http://{IP}:{PORT}/api/v1/discovery"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DiscoveryApi;

import java.io.File;
import java.util.*;

public class DiscoveryApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: auth_ticket
        ApiKeyAuth auth_ticket = (ApiKeyAuth) defaultClient.getAuthentication("auth_ticket");
        auth_ticket.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //auth_ticket.setApiKeyPrefix("Token");

        DiscoveryApi apiInstance = new DiscoveryApi();
        try {
            Discovery_DiscoveryRequestList result = apiInstance.getDiscovery();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DiscoveryApi#getDiscovery");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.DiscoveryApi;

public class DiscoveryApiExample {

    public static void main(String[] args) {
        DiscoveryApi apiInstance = new DiscoveryApi();
        try {
            Discovery_DiscoveryRequestList result = apiInstance.getDiscovery();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DiscoveryApi#getDiscovery");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: auth_ticket)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Auth-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Auth-Token"];


DiscoveryApi *apiInstance = [[DiscoveryApi alloc] init];

// Retrieves all the discoveries
[apiInstance getDiscoveryWithCompletionHandler: 
              ^(Discovery_DiscoveryRequestList output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var CiscoPacketTracerNorthboundApiForNetworkControllerDevice = require('cisco_packet_tracer_northbound_api_for_network_controller_device');
var defaultClient = CiscoPacketTracerNorthboundApiForNetworkControllerDevice.ApiClient.instance;

// Configure API key authorization: auth_ticket
var auth_ticket = defaultClient.authentications['auth_ticket'];
auth_ticket.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//auth_ticket.apiKeyPrefix['X-Auth-Token'] = "Token"

var api = new CiscoPacketTracerNorthboundApiForNetworkControllerDevice.DiscoveryApi()

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDiscovery(callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getDiscoveryExample
    {
        public void main()
        {
            
            // Configure API key authorization: auth_ticket
            Configuration.Default.ApiKey.Add("X-Auth-Token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Auth-Token", "Bearer");

            var apiInstance = new DiscoveryApi();

            try
            {
                // Retrieves all the discoveries
                Discovery_DiscoveryRequestList result = apiInstance.getDiscovery();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DiscoveryApi.getDiscovery: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: auth_ticket
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');

$api_instance = new Swagger\Client\Api\DiscoveryApi();

try {
    $result = $api_instance->getDiscovery();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DiscoveryApi->getDiscovery: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DiscoveryApi;

# Configure API key authorization: auth_ticket
$WWW::SwaggerClient::Configuration::api_key->{'X-Auth-Token'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Auth-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::DiscoveryApi->new();

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

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: auth_ticket
swagger_client.configuration.api_key['X-Auth-Token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Auth-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.DiscoveryApi()


try: 
    # Retrieves all the discoveries
    api_response = api_instance.get_discovery()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DiscoveryApi->getDiscovery: %s\n" % e)

Parameters

Responses

Status: 200 - success

Schema

Status: 401 - Not Authorized Yet, Credentials to be supplied

Status: 500 - The server could not fulfill the request.

Status: 501 - The server has not implemented the functionality required to fulfill the request.

getDiscoveryById

Retrieves the discovery specified by id

Retrieves discovery by ID

/discovery/{id}

Usage and SDK Samples

Curl

curl -X GET -H "X-Auth-Token: [[apiKey]]" "http://{IP}:{PORT}/api/v1/discovery/{id}"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DiscoveryApi;

import java.io.File;
import java.util.*;

public class DiscoveryApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: auth_ticket
        ApiKeyAuth auth_ticket = (ApiKeyAuth) defaultClient.getAuthentication("auth_ticket");
        auth_ticket.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //auth_ticket.setApiKeyPrefix("Token");

        DiscoveryApi apiInstance = new DiscoveryApi();
        String id = id_example; // String | Discovery id
        try {
            Discovery_GetIdResult result = apiInstance.getDiscoveryById(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DiscoveryApi#getDiscoveryById");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.DiscoveryApi;

public class DiscoveryApiExample {

    public static void main(String[] args) {
        DiscoveryApi apiInstance = new DiscoveryApi();
        String id = id_example; // String | Discovery id
        try {
            Discovery_GetIdResult result = apiInstance.getDiscoveryById(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DiscoveryApi#getDiscoveryById");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: auth_ticket)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Auth-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Auth-Token"];

String *id = id_example; // Discovery id

DiscoveryApi *apiInstance = [[DiscoveryApi alloc] init];

// Retrieves the discovery specified by id
[apiInstance getDiscoveryByIdWith:id
              completionHandler: ^(Discovery_GetIdResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var CiscoPacketTracerNorthboundApiForNetworkControllerDevice = require('cisco_packet_tracer_northbound_api_for_network_controller_device');
var defaultClient = CiscoPacketTracerNorthboundApiForNetworkControllerDevice.ApiClient.instance;

// Configure API key authorization: auth_ticket
var auth_ticket = defaultClient.authentications['auth_ticket'];
auth_ticket.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//auth_ticket.apiKeyPrefix['X-Auth-Token'] = "Token"

var api = new CiscoPacketTracerNorthboundApiForNetworkControllerDevice.DiscoveryApi()

var id = id_example; // {String} Discovery id


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDiscoveryById(id, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getDiscoveryByIdExample
    {
        public void main()
        {
            
            // Configure API key authorization: auth_ticket
            Configuration.Default.ApiKey.Add("X-Auth-Token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Auth-Token", "Bearer");

            var apiInstance = new DiscoveryApi();
            var id = id_example;  // String | Discovery id

            try
            {
                // Retrieves the discovery specified by id
                Discovery_GetIdResult result = apiInstance.getDiscoveryById(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DiscoveryApi.getDiscoveryById: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: auth_ticket
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');

$api_instance = new Swagger\Client\Api\DiscoveryApi();
$id = id_example; // String | Discovery id

try {
    $result = $api_instance->getDiscoveryById($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DiscoveryApi->getDiscoveryById: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DiscoveryApi;

# Configure API key authorization: auth_ticket
$WWW::SwaggerClient::Configuration::api_key->{'X-Auth-Token'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Auth-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::DiscoveryApi->new();
my $id = id_example; # String | Discovery id

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

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: auth_ticket
swagger_client.configuration.api_key['X-Auth-Token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Auth-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.DiscoveryApi()
id = id_example # String | Discovery id


try: 
    # Retrieves the discovery specified by id
    api_response = api_instance.get_discovery_by_id(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DiscoveryApi->getDiscoveryById: %s\n" % e)

Parameters

Path parameters

Name	Description
id*	String Discovery id Required

Responses

Status: 200 - The request was successful. The result is contained in the response body.

Schema

Status: 401 - Not Authorized Yet, Credentials to be supplied

Status: 404 - No Resource Found

Status: 500 - The server could not fulfill the request.

Status: 501 - The server has not implemented the functionality required to fulfill the request.

getDiscoveryByRange

Retrieves the discovery in the given range

Gets the discovery for the range specified

/discovery/{startIndex}/{numRecords}

Usage and SDK Samples

Curl

curl -X GET -H "X-Auth-Token: [[apiKey]]" "http://{IP}:{PORT}/api/v1/discovery/{startIndex}/{numRecords}"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DiscoveryApi;

import java.io.File;
import java.util.*;

public class DiscoveryApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: auth_ticket
        ApiKeyAuth auth_ticket = (ApiKeyAuth) defaultClient.getAuthentication("auth_ticket");
        auth_ticket.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //auth_ticket.setApiKeyPrefix("Token");

        DiscoveryApi apiInstance = new DiscoveryApi();
        Integer startIndex = 56; // Integer | Start index [0-254]
        Integer numRecords = 56; // Integer | Number of records to return [0-255]
        try {
            Discovery_DiscoveryRequestList result = apiInstance.getDiscoveryByRange(startIndex, numRecords);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DiscoveryApi#getDiscoveryByRange");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.DiscoveryApi;

public class DiscoveryApiExample {

    public static void main(String[] args) {
        DiscoveryApi apiInstance = new DiscoveryApi();
        Integer startIndex = 56; // Integer | Start index [0-254]
        Integer numRecords = 56; // Integer | Number of records to return [0-255]
        try {
            Discovery_DiscoveryRequestList result = apiInstance.getDiscoveryByRange(startIndex, numRecords);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DiscoveryApi#getDiscoveryByRange");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: auth_ticket)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Auth-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Auth-Token"];

Integer *startIndex = 56; // Start index [0-254]
Integer *numRecords = 56; // Number of records to return [0-255]

DiscoveryApi *apiInstance = [[DiscoveryApi alloc] init];

// Retrieves the discovery in the given range
[apiInstance getDiscoveryByRangeWith:startIndex
    numRecords:numRecords
              completionHandler: ^(Discovery_DiscoveryRequestList output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var CiscoPacketTracerNorthboundApiForNetworkControllerDevice = require('cisco_packet_tracer_northbound_api_for_network_controller_device');
var defaultClient = CiscoPacketTracerNorthboundApiForNetworkControllerDevice.ApiClient.instance;

// Configure API key authorization: auth_ticket
var auth_ticket = defaultClient.authentications['auth_ticket'];
auth_ticket.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//auth_ticket.apiKeyPrefix['X-Auth-Token'] = "Token"

var api = new CiscoPacketTracerNorthboundApiForNetworkControllerDevice.DiscoveryApi()

var startIndex = 56; // {Integer} Start index [0-254]

var numRecords = 56; // {Integer} Number of records to return [0-255]


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDiscoveryByRange(startIndex, numRecords, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getDiscoveryByRangeExample
    {
        public void main()
        {
            
            // Configure API key authorization: auth_ticket
            Configuration.Default.ApiKey.Add("X-Auth-Token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Auth-Token", "Bearer");

            var apiInstance = new DiscoveryApi();
            var startIndex = 56;  // Integer | Start index [0-254]
            var numRecords = 56;  // Integer | Number of records to return [0-255]

            try
            {
                // Retrieves the discovery in the given range
                Discovery_DiscoveryRequestList result = apiInstance.getDiscoveryByRange(startIndex, numRecords);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DiscoveryApi.getDiscoveryByRange: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: auth_ticket
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');

$api_instance = new Swagger\Client\Api\DiscoveryApi();
$startIndex = 56; // Integer | Start index [0-254]
$numRecords = 56; // Integer | Number of records to return [0-255]

try {
    $result = $api_instance->getDiscoveryByRange($startIndex, $numRecords);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DiscoveryApi->getDiscoveryByRange: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DiscoveryApi;

# Configure API key authorization: auth_ticket
$WWW::SwaggerClient::Configuration::api_key->{'X-Auth-Token'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Auth-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::DiscoveryApi->new();
my $startIndex = 56; # Integer | Start index [0-254]
my $numRecords = 56; # Integer | Number of records to return [0-255]

eval { 
    my $result = $api_instance->getDiscoveryByRange(startIndex => $startIndex, numRecords => $numRecords);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DiscoveryApi->getDiscoveryByRange: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: auth_ticket
swagger_client.configuration.api_key['X-Auth-Token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Auth-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.DiscoveryApi()
startIndex = 56 # Integer | Start index [0-254]
numRecords = 56 # Integer | Number of records to return [0-255]


try: 
    # Retrieves the discovery in the given range
    api_response = api_instance.get_discovery_by_range(startIndex, numRecords)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DiscoveryApi->getDiscoveryByRange: %s\n" % e)

Parameters

Path parameters

Name	Description
startIndex*	Integer Start index [0-254] Required
numRecords*	Integer Number of records to return [0-255] Required

Responses

Status: 200 - The request was successful. The result is contained in the response body.

Schema

Status: 400 - The client made a request that the server could not understand (for example, the request syntax is incorrect).

Status: 401 - Not Authorized Yet, Credentials to be supplied

Status: 500 - The server could not fulfill the request.

Status: 501 - The server has not implemented the functionality required to fulfill the request.

getDiscoveryCount

Retrieves the number of discovery

Gets the count of all available discovery

/discovery/count

Usage and SDK Samples

Curl

curl -X GET -H "X-Auth-Token: [[apiKey]]" "http://{IP}:{PORT}/api/v1/discovery/count"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DiscoveryApi;

import java.io.File;
import java.util.*;

public class DiscoveryApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: auth_ticket
        ApiKeyAuth auth_ticket = (ApiKeyAuth) defaultClient.getAuthentication("auth_ticket");
        auth_ticket.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //auth_ticket.setApiKeyPrefix("Token");

        DiscoveryApi apiInstance = new DiscoveryApi();
        try {
            Common_IntegerResponse result = apiInstance.getDiscoveryCount();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DiscoveryApi#getDiscoveryCount");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.DiscoveryApi;

public class DiscoveryApiExample {

    public static void main(String[] args) {
        DiscoveryApi apiInstance = new DiscoveryApi();
        try {
            Common_IntegerResponse result = apiInstance.getDiscoveryCount();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DiscoveryApi#getDiscoveryCount");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: auth_ticket)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Auth-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Auth-Token"];


DiscoveryApi *apiInstance = [[DiscoveryApi alloc] init];

// Retrieves the number of discovery
[apiInstance getDiscoveryCountWithCompletionHandler: 
              ^(Common_IntegerResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var CiscoPacketTracerNorthboundApiForNetworkControllerDevice = require('cisco_packet_tracer_northbound_api_for_network_controller_device');
var defaultClient = CiscoPacketTracerNorthboundApiForNetworkControllerDevice.ApiClient.instance;

// Configure API key authorization: auth_ticket
var auth_ticket = defaultClient.authentications['auth_ticket'];
auth_ticket.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//auth_ticket.apiKeyPrefix['X-Auth-Token'] = "Token"

var api = new CiscoPacketTracerNorthboundApiForNetworkControllerDevice.DiscoveryApi()

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDiscoveryCount(callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getDiscoveryCountExample
    {
        public void main()
        {
            
            // Configure API key authorization: auth_ticket
            Configuration.Default.ApiKey.Add("X-Auth-Token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Auth-Token", "Bearer");

            var apiInstance = new DiscoveryApi();

            try
            {
                // Retrieves the number of discovery
                Common_IntegerResponse result = apiInstance.getDiscoveryCount();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DiscoveryApi.getDiscoveryCount: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: auth_ticket
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');

$api_instance = new Swagger\Client\Api\DiscoveryApi();

try {
    $result = $api_instance->getDiscoveryCount();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DiscoveryApi->getDiscoveryCount: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DiscoveryApi;

# Configure API key authorization: auth_ticket
$WWW::SwaggerClient::Configuration::api_key->{'X-Auth-Token'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Auth-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::DiscoveryApi->new();

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

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: auth_ticket
swagger_client.configuration.api_key['X-Auth-Token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Auth-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.DiscoveryApi()


try: 
    # Retrieves the number of discovery
    api_response = api_instance.get_discovery_count()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DiscoveryApi->getDiscoveryCount: %s\n" % e)

Parameters

Responses

Status: 200 - The request was successful. The result is contained in the response body.

Schema

Status: 401 - Not Authorized Yet, Credentials to be supplied

Status: 500 - The server could not fulfill the request.

Status: 501 - The server has not implemented the functionality required to fulfill the request.

getNetworkDeviceByDiscoveryId

Retrieves the network devices discovered in the discovery specified by id

Gets the network devices discovered for the given discovery

/discovery/{id}/network-device

Usage and SDK Samples

Curl

curl -X GET -H "X-Auth-Token: [[apiKey]]" "http://{IP}:{PORT}/api/v1/discovery/{id}/network-device"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DiscoveryApi;

import java.io.File;
import java.util.*;

public class DiscoveryApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: auth_ticket
        ApiKeyAuth auth_ticket = (ApiKeyAuth) defaultClient.getAuthentication("auth_ticket");
        auth_ticket.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //auth_ticket.setApiKeyPrefix("Token");

        DiscoveryApi apiInstance = new DiscoveryApi();
        String id = id_example; // String | Discovery id
        try {
            Discovery_GetNetworkDeviceListResult result = apiInstance.getNetworkDeviceByDiscoveryId(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DiscoveryApi#getNetworkDeviceByDiscoveryId");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.DiscoveryApi;

public class DiscoveryApiExample {

    public static void main(String[] args) {
        DiscoveryApi apiInstance = new DiscoveryApi();
        String id = id_example; // String | Discovery id
        try {
            Discovery_GetNetworkDeviceListResult result = apiInstance.getNetworkDeviceByDiscoveryId(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DiscoveryApi#getNetworkDeviceByDiscoveryId");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: auth_ticket)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Auth-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Auth-Token"];

String *id = id_example; // Discovery id

DiscoveryApi *apiInstance = [[DiscoveryApi alloc] init];

// Retrieves the network devices discovered in the discovery specified by id
[apiInstance getNetworkDeviceByDiscoveryIdWith:id
              completionHandler: ^(Discovery_GetNetworkDeviceListResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var CiscoPacketTracerNorthboundApiForNetworkControllerDevice = require('cisco_packet_tracer_northbound_api_for_network_controller_device');
var defaultClient = CiscoPacketTracerNorthboundApiForNetworkControllerDevice.ApiClient.instance;

// Configure API key authorization: auth_ticket
var auth_ticket = defaultClient.authentications['auth_ticket'];
auth_ticket.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//auth_ticket.apiKeyPrefix['X-Auth-Token'] = "Token"

var api = new CiscoPacketTracerNorthboundApiForNetworkControllerDevice.DiscoveryApi()

var id = id_example; // {String} Discovery id


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getNetworkDeviceByDiscoveryId(id, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getNetworkDeviceByDiscoveryIdExample
    {
        public void main()
        {
            
            // Configure API key authorization: auth_ticket
            Configuration.Default.ApiKey.Add("X-Auth-Token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Auth-Token", "Bearer");

            var apiInstance = new DiscoveryApi();
            var id = id_example;  // String | Discovery id

            try
            {
                // Retrieves the network devices discovered in the discovery specified by id
                Discovery_GetNetworkDeviceListResult result = apiInstance.getNetworkDeviceByDiscoveryId(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DiscoveryApi.getNetworkDeviceByDiscoveryId: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: auth_ticket
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');

$api_instance = new Swagger\Client\Api\DiscoveryApi();
$id = id_example; // String | Discovery id

try {
    $result = $api_instance->getNetworkDeviceByDiscoveryId($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DiscoveryApi->getNetworkDeviceByDiscoveryId: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DiscoveryApi;

# Configure API key authorization: auth_ticket
$WWW::SwaggerClient::Configuration::api_key->{'X-Auth-Token'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Auth-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::DiscoveryApi->new();
my $id = id_example; # String | Discovery id

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

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: auth_ticket
swagger_client.configuration.api_key['X-Auth-Token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Auth-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.DiscoveryApi()
id = id_example # String | Discovery id


try: 
    # Retrieves the network devices discovered in the discovery specified by id
    api_response = api_instance.get_network_device_by_discovery_id(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DiscoveryApi->getNetworkDeviceByDiscoveryId: %s\n" % e)

Parameters

Path parameters

Name	Description
id*	String Discovery id Required

Responses

Status: 200 - The request was successful. The result is contained in the response body.

Schema

Status: 401 - Not Authorized Yet, Credentials to be supplied

Status: 404 - No Resource Found

Status: 500 - The server could not fulfill the request.

Status: 501 - The server has not implemented the functionality required to fulfill the request.

getNetworkDeviceByDiscoveryIdByRange

Retrieves the range of network devices discovered for the given discovery

Gets the network devices discovered for the given discovery and for the given range. The maximum number of records that could be retrieved is 500

/discovery/{id}/network-device/{startIndex}/{recordsToReturn}

Usage and SDK Samples

Curl

curl -X GET -H "X-Auth-Token: [[apiKey]]" "http://{IP}:{PORT}/api/v1/discovery/{id}/network-device/{startIndex}/{recordsToReturn}"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DiscoveryApi;

import java.io.File;
import java.util.*;

public class DiscoveryApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: auth_ticket
        ApiKeyAuth auth_ticket = (ApiKeyAuth) defaultClient.getAuthentication("auth_ticket");
        auth_ticket.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //auth_ticket.setApiKeyPrefix("Token");

        DiscoveryApi apiInstance = new DiscoveryApi();
        String id = id_example; // String | Discovery id
        Integer startIndex = 56; // Integer | Start index [0-499]
        Integer recordsToReturn = 56; // Integer | Number of records to return [0-500]
        try {
            Discovery_GetNetworkDeviceListResult result = apiInstance.getNetworkDeviceByDiscoveryIdByRange(id, startIndex, recordsToReturn);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DiscoveryApi#getNetworkDeviceByDiscoveryIdByRange");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.DiscoveryApi;

public class DiscoveryApiExample {

    public static void main(String[] args) {
        DiscoveryApi apiInstance = new DiscoveryApi();
        String id = id_example; // String | Discovery id
        Integer startIndex = 56; // Integer | Start index [0-499]
        Integer recordsToReturn = 56; // Integer | Number of records to return [0-500]
        try {
            Discovery_GetNetworkDeviceListResult result = apiInstance.getNetworkDeviceByDiscoveryIdByRange(id, startIndex, recordsToReturn);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DiscoveryApi#getNetworkDeviceByDiscoveryIdByRange");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: auth_ticket)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Auth-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Auth-Token"];

String *id = id_example; // Discovery id
Integer *startIndex = 56; // Start index [0-499]
Integer *recordsToReturn = 56; // Number of records to return [0-500]

DiscoveryApi *apiInstance = [[DiscoveryApi alloc] init];

// Retrieves the range of network devices discovered for the given discovery
[apiInstance getNetworkDeviceByDiscoveryIdByRangeWith:id
    startIndex:startIndex
    recordsToReturn:recordsToReturn
              completionHandler: ^(Discovery_GetNetworkDeviceListResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var CiscoPacketTracerNorthboundApiForNetworkControllerDevice = require('cisco_packet_tracer_northbound_api_for_network_controller_device');
var defaultClient = CiscoPacketTracerNorthboundApiForNetworkControllerDevice.ApiClient.instance;

// Configure API key authorization: auth_ticket
var auth_ticket = defaultClient.authentications['auth_ticket'];
auth_ticket.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//auth_ticket.apiKeyPrefix['X-Auth-Token'] = "Token"

var api = new CiscoPacketTracerNorthboundApiForNetworkControllerDevice.DiscoveryApi()

var id = id_example; // {String} Discovery id

var startIndex = 56; // {Integer} Start index [0-499]

var recordsToReturn = 56; // {Integer} Number of records to return [0-500]


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getNetworkDeviceByDiscoveryIdByRange(id, startIndex, recordsToReturn, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getNetworkDeviceByDiscoveryIdByRangeExample
    {
        public void main()
        {
            
            // Configure API key authorization: auth_ticket
            Configuration.Default.ApiKey.Add("X-Auth-Token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Auth-Token", "Bearer");

            var apiInstance = new DiscoveryApi();
            var id = id_example;  // String | Discovery id
            var startIndex = 56;  // Integer | Start index [0-499]
            var recordsToReturn = 56;  // Integer | Number of records to return [0-500]

            try
            {
                // Retrieves the range of network devices discovered for the given discovery
                Discovery_GetNetworkDeviceListResult result = apiInstance.getNetworkDeviceByDiscoveryIdByRange(id, startIndex, recordsToReturn);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DiscoveryApi.getNetworkDeviceByDiscoveryIdByRange: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: auth_ticket
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');

$api_instance = new Swagger\Client\Api\DiscoveryApi();
$id = id_example; // String | Discovery id
$startIndex = 56; // Integer | Start index [0-499]
$recordsToReturn = 56; // Integer | Number of records to return [0-500]

try {
    $result = $api_instance->getNetworkDeviceByDiscoveryIdByRange($id, $startIndex, $recordsToReturn);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DiscoveryApi->getNetworkDeviceByDiscoveryIdByRange: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DiscoveryApi;

# Configure API key authorization: auth_ticket
$WWW::SwaggerClient::Configuration::api_key->{'X-Auth-Token'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Auth-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::DiscoveryApi->new();
my $id = id_example; # String | Discovery id
my $startIndex = 56; # Integer | Start index [0-499]
my $recordsToReturn = 56; # Integer | Number of records to return [0-500]

eval { 
    my $result = $api_instance->getNetworkDeviceByDiscoveryIdByRange(id => $id, startIndex => $startIndex, recordsToReturn => $recordsToReturn);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DiscoveryApi->getNetworkDeviceByDiscoveryIdByRange: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: auth_ticket
swagger_client.configuration.api_key['X-Auth-Token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Auth-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.DiscoveryApi()
id = id_example # String | Discovery id
startIndex = 56 # Integer | Start index [0-499]
recordsToReturn = 56 # Integer | Number of records to return [0-500]


try: 
    # Retrieves the range of network devices discovered for the given discovery
    api_response = api_instance.get_network_device_by_discovery_id_by_range(id, startIndex, recordsToReturn)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DiscoveryApi->getNetworkDeviceByDiscoveryIdByRange: %s\n" % e)

Parameters

Path parameters

Name	Description
id*	String Discovery id Required
startIndex*	Integer Start index [0-499] Required
recordsToReturn*	Integer Number of records to return [0-500] Required

Responses

Status: 200 - The request was successful. The result is contained in the response body.

Schema

Status: 400 - The client made a request that the server could not understand (for example, the request syntax is incorrect).

Status: 401 - Not Authorized Yet, Credentials to be supplied

Status: 404 - No Resource Found

Status: 500 - The server could not fulfill the request.

Status: 501 - The server has not implemented the functionality required to fulfill the request.

getNetworkDeviceCountByDiscoveryId

Retrieves the number of network devices discovered in the discovery specified by id

Gets the count of network devices discovered in the given discovery

/discovery/{id}/network-device/count

Usage and SDK Samples

Curl

curl -X GET -H "X-Auth-Token: [[apiKey]]" "http://{IP}:{PORT}/api/v1/discovery/{id}/network-device/count"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DiscoveryApi;

import java.io.File;
import java.util.*;

public class DiscoveryApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: auth_ticket
        ApiKeyAuth auth_ticket = (ApiKeyAuth) defaultClient.getAuthentication("auth_ticket");
        auth_ticket.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //auth_ticket.setApiKeyPrefix("Token");

        DiscoveryApi apiInstance = new DiscoveryApi();
        String id = id_example; // String | Discovery id
        try {
            Common_IntegerResponse result = apiInstance.getNetworkDeviceCountByDiscoveryId(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DiscoveryApi#getNetworkDeviceCountByDiscoveryId");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.DiscoveryApi;

public class DiscoveryApiExample {

    public static void main(String[] args) {
        DiscoveryApi apiInstance = new DiscoveryApi();
        String id = id_example; // String | Discovery id
        try {
            Common_IntegerResponse result = apiInstance.getNetworkDeviceCountByDiscoveryId(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DiscoveryApi#getNetworkDeviceCountByDiscoveryId");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: auth_ticket)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Auth-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Auth-Token"];

String *id = id_example; // Discovery id

DiscoveryApi *apiInstance = [[DiscoveryApi alloc] init];

// Retrieves the number of network devices discovered in the discovery specified by id
[apiInstance getNetworkDeviceCountByDiscoveryIdWith:id
              completionHandler: ^(Common_IntegerResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var CiscoPacketTracerNorthboundApiForNetworkControllerDevice = require('cisco_packet_tracer_northbound_api_for_network_controller_device');
var defaultClient = CiscoPacketTracerNorthboundApiForNetworkControllerDevice.ApiClient.instance;

// Configure API key authorization: auth_ticket
var auth_ticket = defaultClient.authentications['auth_ticket'];
auth_ticket.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//auth_ticket.apiKeyPrefix['X-Auth-Token'] = "Token"

var api = new CiscoPacketTracerNorthboundApiForNetworkControllerDevice.DiscoveryApi()

var id = id_example; // {String} Discovery id


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getNetworkDeviceCountByDiscoveryId(id, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getNetworkDeviceCountByDiscoveryIdExample
    {
        public void main()
        {
            
            // Configure API key authorization: auth_ticket
            Configuration.Default.ApiKey.Add("X-Auth-Token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Auth-Token", "Bearer");

            var apiInstance = new DiscoveryApi();
            var id = id_example;  // String | Discovery id

            try
            {
                // Retrieves the number of network devices discovered in the discovery specified by id
                Common_IntegerResponse result = apiInstance.getNetworkDeviceCountByDiscoveryId(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DiscoveryApi.getNetworkDeviceCountByDiscoveryId: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: auth_ticket
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');

$api_instance = new Swagger\Client\Api\DiscoveryApi();
$id = id_example; // String | Discovery id

try {
    $result = $api_instance->getNetworkDeviceCountByDiscoveryId($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DiscoveryApi->getNetworkDeviceCountByDiscoveryId: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DiscoveryApi;

# Configure API key authorization: auth_ticket
$WWW::SwaggerClient::Configuration::api_key->{'X-Auth-Token'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Auth-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::DiscoveryApi->new();
my $id = id_example; # String | Discovery id

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

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: auth_ticket
swagger_client.configuration.api_key['X-Auth-Token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Auth-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.DiscoveryApi()
id = id_example # String | Discovery id


try: 
    # Retrieves the number of network devices discovered in the discovery specified by id
    api_response = api_instance.get_network_device_count_by_discovery_id(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DiscoveryApi->getNetworkDeviceCountByDiscoveryId: %s\n" % e)

Parameters

Path parameters

Name	Description
id*	String Discovery id Required

Responses

Status: 200 - The request was successful. The result is contained in the response body.

Schema

Status: 401 - Not Authorized Yet, Credentials to be supplied

Status: 404 - No Resource Found

Status: 500 - The server could not fulfill the request.

Status: 501 - The server has not implemented the functionality required to fulfill the request.

insertDiscovery

Starts a new discovery process and returns a task-id

Initiates discovery with the given parameters

/discovery

Usage and SDK Samples

Curl

curl -X POST -H "X-Auth-Token: [[apiKey]]" "http://{IP}:{PORT}/api/v1/discovery"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DiscoveryApi;

import java.io.File;
import java.util.*;

public class DiscoveryApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: auth_ticket
        ApiKeyAuth auth_ticket = (ApiKeyAuth) defaultClient.getAuthentication("auth_ticket");
        auth_ticket.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //auth_ticket.setApiKeyPrefix("Token");

        DiscoveryApi apiInstance = new DiscoveryApi();
        Discovery_InventoryRequest inventory = ; // Discovery_InventoryRequest | Discovery request that holds the parameters required for discovery
        try {
            Discovery_DiscoveryResult result = apiInstance.insertDiscovery(inventory);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DiscoveryApi#insertDiscovery");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.DiscoveryApi;

public class DiscoveryApiExample {

    public static void main(String[] args) {
        DiscoveryApi apiInstance = new DiscoveryApi();
        Discovery_InventoryRequest inventory = ; // Discovery_InventoryRequest | Discovery request that holds the parameters required for discovery
        try {
            Discovery_DiscoveryResult result = apiInstance.insertDiscovery(inventory);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DiscoveryApi#insertDiscovery");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: auth_ticket)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Auth-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Auth-Token"];

Discovery_InventoryRequest *inventory = ; // Discovery request that holds the parameters required for discovery

DiscoveryApi *apiInstance = [[DiscoveryApi alloc] init];

// Starts a new discovery process and returns a task-id
[apiInstance insertDiscoveryWith:inventory
              completionHandler: ^(Discovery_DiscoveryResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var CiscoPacketTracerNorthboundApiForNetworkControllerDevice = require('cisco_packet_tracer_northbound_api_for_network_controller_device');
var defaultClient = CiscoPacketTracerNorthboundApiForNetworkControllerDevice.ApiClient.instance;

// Configure API key authorization: auth_ticket
var auth_ticket = defaultClient.authentications['auth_ticket'];
auth_ticket.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//auth_ticket.apiKeyPrefix['X-Auth-Token'] = "Token"

var api = new CiscoPacketTracerNorthboundApiForNetworkControllerDevice.DiscoveryApi()

var inventory = ; // {Discovery_InventoryRequest} Discovery request that holds the parameters required for discovery


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.insertDiscovery(inventory, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class insertDiscoveryExample
    {
        public void main()
        {
            
            // Configure API key authorization: auth_ticket
            Configuration.Default.ApiKey.Add("X-Auth-Token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Auth-Token", "Bearer");

            var apiInstance = new DiscoveryApi();
            var inventory = new Discovery_InventoryRequest(); // Discovery_InventoryRequest | Discovery request that holds the parameters required for discovery

            try
            {
                // Starts a new discovery process and returns a task-id
                Discovery_DiscoveryResult result = apiInstance.insertDiscovery(inventory);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DiscoveryApi.insertDiscovery: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: auth_ticket
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');

$api_instance = new Swagger\Client\Api\DiscoveryApi();
$inventory = ; // Discovery_InventoryRequest | Discovery request that holds the parameters required for discovery

try {
    $result = $api_instance->insertDiscovery($inventory);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DiscoveryApi->insertDiscovery: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DiscoveryApi;

# Configure API key authorization: auth_ticket
$WWW::SwaggerClient::Configuration::api_key->{'X-Auth-Token'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Auth-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::DiscoveryApi->new();
my $inventory = WWW::SwaggerClient::Object::Discovery_InventoryRequest->new(); # Discovery_InventoryRequest | Discovery request that holds the parameters required for discovery

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

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: auth_ticket
swagger_client.configuration.api_key['X-Auth-Token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Auth-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.DiscoveryApi()
inventory =  # Discovery_InventoryRequest | Discovery request that holds the parameters required for discovery


try: 
    # Starts a new discovery process and returns a task-id
    api_response = api_instance.insert_discovery(inventory)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DiscoveryApi->insertDiscovery: %s\n" % e)

Parameters

Body parameters

Name	Description
inventory *

Responses

Status: 200 - The request was successful. The result is contained in the response body.

Schema

Status: 201 - The POST request was fulfilled and a new resource has been created. Information about the resource is in the response body.

Status: 400 - The client made a request that the server could not understand (for example, the request syntax is incorrect).

Status: 401 - Not Authorized Yet, Credentials to be supplied

Status: 500 - The server could not fulfill the request.

Status: 501 - The server has not implemented the functionality required to fulfill the request.

updateDiscovery

Updates an existing discovery specified by id - only for starting/stopping the discovery

Stops or starts an existing discovery

/discovery

Usage and SDK Samples

Curl

curl -X PUT -H "X-Auth-Token: [[apiKey]]" "http://{IP}:{PORT}/api/v1/discovery"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DiscoveryApi;

import java.io.File;
import java.util.*;

public class DiscoveryApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: auth_ticket
        ApiKeyAuth auth_ticket = (ApiKeyAuth) defaultClient.getAuthentication("auth_ticket");
        auth_ticket.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //auth_ticket.setApiKeyPrefix("Token");

        DiscoveryApi apiInstance = new DiscoveryApi();
        Discovery_DiscoveryRequest discovery = ; // Discovery_DiscoveryRequest | Discovery request that holds the status of discovery as active / inactive
        try {
            Discovery_DiscoveryResult result = apiInstance.updateDiscovery(discovery);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DiscoveryApi#updateDiscovery");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.DiscoveryApi;

public class DiscoveryApiExample {

    public static void main(String[] args) {
        DiscoveryApi apiInstance = new DiscoveryApi();
        Discovery_DiscoveryRequest discovery = ; // Discovery_DiscoveryRequest | Discovery request that holds the status of discovery as active / inactive
        try {
            Discovery_DiscoveryResult result = apiInstance.updateDiscovery(discovery);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DiscoveryApi#updateDiscovery");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: auth_ticket)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Auth-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Auth-Token"];

Discovery_DiscoveryRequest *discovery = ; // Discovery request that holds the status of discovery as active / inactive

DiscoveryApi *apiInstance = [[DiscoveryApi alloc] init];

// Updates an existing discovery specified by id - only for starting/stopping the discovery
[apiInstance updateDiscoveryWith:discovery
              completionHandler: ^(Discovery_DiscoveryResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var CiscoPacketTracerNorthboundApiForNetworkControllerDevice = require('cisco_packet_tracer_northbound_api_for_network_controller_device');
var defaultClient = CiscoPacketTracerNorthboundApiForNetworkControllerDevice.ApiClient.instance;

// Configure API key authorization: auth_ticket
var auth_ticket = defaultClient.authentications['auth_ticket'];
auth_ticket.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//auth_ticket.apiKeyPrefix['X-Auth-Token'] = "Token"

var api = new CiscoPacketTracerNorthboundApiForNetworkControllerDevice.DiscoveryApi()

var discovery = ; // {Discovery_DiscoveryRequest} Discovery request that holds the status of discovery as active / inactive


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateDiscovery(discovery, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateDiscoveryExample
    {
        public void main()
        {
            
            // Configure API key authorization: auth_ticket
            Configuration.Default.ApiKey.Add("X-Auth-Token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Auth-Token", "Bearer");

            var apiInstance = new DiscoveryApi();
            var discovery = new Discovery_DiscoveryRequest(); // Discovery_DiscoveryRequest | Discovery request that holds the status of discovery as active / inactive

            try
            {
                // Updates an existing discovery specified by id - only for starting/stopping the discovery
                Discovery_DiscoveryResult result = apiInstance.updateDiscovery(discovery);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DiscoveryApi.updateDiscovery: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: auth_ticket
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');

$api_instance = new Swagger\Client\Api\DiscoveryApi();
$discovery = ; // Discovery_DiscoveryRequest | Discovery request that holds the status of discovery as active / inactive

try {
    $result = $api_instance->updateDiscovery($discovery);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DiscoveryApi->updateDiscovery: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DiscoveryApi;

# Configure API key authorization: auth_ticket
$WWW::SwaggerClient::Configuration::api_key->{'X-Auth-Token'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Auth-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::DiscoveryApi->new();
my $discovery = WWW::SwaggerClient::Object::Discovery_DiscoveryRequest->new(); # Discovery_DiscoveryRequest | Discovery request that holds the status of discovery as active / inactive

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

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: auth_ticket
swagger_client.configuration.api_key['X-Auth-Token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Auth-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.DiscoveryApi()
discovery =  # Discovery_DiscoveryRequest | Discovery request that holds the status of discovery as active / inactive


try: 
    # Updates an existing discovery specified by id - only for starting/stopping the discovery
    api_response = api_instance.update_discovery(discovery)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DiscoveryApi->updateDiscovery: %s\n" % e)

Parameters

Body parameters

Name	Description
discovery *

Responses

Status: 200 - The request was successful. The result is contained in the response body.

Schema

Status: 400 - The client made a request that the server could not understand (for example, the request syntax is incorrect).

Status: 401 - Not Authorized Yet, Credentials to be supplied

Status: 500 - The server could not fulfill the request.

Status: 501 - The server has not implemented the functionality required to fulfill the request.

Flow Analysis API

deleteFlowAnalysis

Deletes a flow analysis request

Deletes a flow analysis request by its id

/flow-analysis/{flowAnalysisId}

Usage and SDK Samples

Curl

curl -X DELETE -H "X-Auth-Token: [[apiKey]]" "http://{IP}:{PORT}/api/v1/flow-analysis/{flowAnalysisId}"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.FlowAnalysisApi;

import java.io.File;
import java.util.*;

public class FlowAnalysisApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: auth_ticket
        ApiKeyAuth auth_ticket = (ApiKeyAuth) defaultClient.getAuthentication("auth_ticket");
        auth_ticket.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //auth_ticket.setApiKeyPrefix("Token");

        FlowAnalysisApi apiInstance = new FlowAnalysisApi();
        String flowAnalysisId = flowAnalysisId_example; // String | Flow analysis request id
        try {
            Common_BooleanResponse result = apiInstance.deleteFlowAnalysis(flowAnalysisId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FlowAnalysisApi#deleteFlowAnalysis");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.FlowAnalysisApi;

public class FlowAnalysisApiExample {

    public static void main(String[] args) {
        FlowAnalysisApi apiInstance = new FlowAnalysisApi();
        String flowAnalysisId = flowAnalysisId_example; // String | Flow analysis request id
        try {
            Common_BooleanResponse result = apiInstance.deleteFlowAnalysis(flowAnalysisId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FlowAnalysisApi#deleteFlowAnalysis");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: auth_ticket)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Auth-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Auth-Token"];

String *flowAnalysisId = flowAnalysisId_example; // Flow analysis request id

FlowAnalysisApi *apiInstance = [[FlowAnalysisApi alloc] init];

// Deletes a flow analysis request
[apiInstance deleteFlowAnalysisWith:flowAnalysisId
              completionHandler: ^(Common_BooleanResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var CiscoPacketTracerNorthboundApiForNetworkControllerDevice = require('cisco_packet_tracer_northbound_api_for_network_controller_device');
var defaultClient = CiscoPacketTracerNorthboundApiForNetworkControllerDevice.ApiClient.instance;

// Configure API key authorization: auth_ticket
var auth_ticket = defaultClient.authentications['auth_ticket'];
auth_ticket.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//auth_ticket.apiKeyPrefix['X-Auth-Token'] = "Token"

var api = new CiscoPacketTracerNorthboundApiForNetworkControllerDevice.FlowAnalysisApi()

var flowAnalysisId = flowAnalysisId_example; // {String} Flow analysis request id


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteFlowAnalysis(flowAnalysisId, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteFlowAnalysisExample
    {
        public void main()
        {
            
            // Configure API key authorization: auth_ticket
            Configuration.Default.ApiKey.Add("X-Auth-Token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Auth-Token", "Bearer");

            var apiInstance = new FlowAnalysisApi();
            var flowAnalysisId = flowAnalysisId_example;  // String | Flow analysis request id

            try
            {
                // Deletes a flow analysis request
                Common_BooleanResponse result = apiInstance.deleteFlowAnalysis(flowAnalysisId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FlowAnalysisApi.deleteFlowAnalysis: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: auth_ticket
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');

$api_instance = new Swagger\Client\Api\FlowAnalysisApi();
$flowAnalysisId = flowAnalysisId_example; // String | Flow analysis request id

try {
    $result = $api_instance->deleteFlowAnalysis($flowAnalysisId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FlowAnalysisApi->deleteFlowAnalysis: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::FlowAnalysisApi;

# Configure API key authorization: auth_ticket
$WWW::SwaggerClient::Configuration::api_key->{'X-Auth-Token'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Auth-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::FlowAnalysisApi->new();
my $flowAnalysisId = flowAnalysisId_example; # String | Flow analysis request id

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

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: auth_ticket
swagger_client.configuration.api_key['X-Auth-Token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Auth-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.FlowAnalysisApi()
flowAnalysisId = flowAnalysisId_example # String | Flow analysis request id


try: 
    # Deletes a flow analysis request
    api_response = api_instance.delete_flow_analysis(flowAnalysisId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FlowAnalysisApi->deleteFlowAnalysis: %s\n" % e)

Parameters

Path parameters

Name	Description
flowAnalysisId*	String Flow analysis request id Required

Responses

Status: 200 - The request was successful. The result is contained in the response body.

Schema

Status: 401 - Not Authorized Yet, Credentials to be supplied

Status: 404 - No Resource Found

Status: 500 - The server could not fulfill the request.

Status: 501 - The server has not implemented the functionality required to fulfill the request.

flowAnalysis

Retrieves a summary of all flow analyses stored

Retrieves a summary of all flow analyses stored. Filters the results by given parameters.

/flow-analysis

Usage and SDK Samples

Curl

curl -X GET -H "X-Auth-Token: [[apiKey]]" "http://{IP}:{PORT}/api/v1/flow-analysis"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.FlowAnalysisApi;

import java.io.File;
import java.util.*;

public class FlowAnalysisApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: auth_ticket
        ApiKeyAuth auth_ticket = (ApiKeyAuth) defaultClient.getAuthentication("auth_ticket");
        auth_ticket.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //auth_ticket.setApiKeyPrefix("Token");

        FlowAnalysisApi apiInstance = new FlowAnalysisApi();
        try {
            FlowAnalysis_Output result = apiInstance.flowAnalysis();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FlowAnalysisApi#flowAnalysis");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.FlowAnalysisApi;

public class FlowAnalysisApiExample {

    public static void main(String[] args) {
        FlowAnalysisApi apiInstance = new FlowAnalysisApi();
        try {
            FlowAnalysis_Output result = apiInstance.flowAnalysis();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FlowAnalysisApi#flowAnalysis");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: auth_ticket)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Auth-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Auth-Token"];


FlowAnalysisApi *apiInstance = [[FlowAnalysisApi alloc] init];

// Retrieves a summary of all flow analyses stored
[apiInstance flowAnalysisWithCompletionHandler: 
              ^(FlowAnalysis_Output output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var CiscoPacketTracerNorthboundApiForNetworkControllerDevice = require('cisco_packet_tracer_northbound_api_for_network_controller_device');
var defaultClient = CiscoPacketTracerNorthboundApiForNetworkControllerDevice.ApiClient.instance;

// Configure API key authorization: auth_ticket
var auth_ticket = defaultClient.authentications['auth_ticket'];
auth_ticket.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//auth_ticket.apiKeyPrefix['X-Auth-Token'] = "Token"

var api = new CiscoPacketTracerNorthboundApiForNetworkControllerDevice.FlowAnalysisApi()

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.flowAnalysis(callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class flowAnalysisExample
    {
        public void main()
        {
            
            // Configure API key authorization: auth_ticket
            Configuration.Default.ApiKey.Add("X-Auth-Token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Auth-Token", "Bearer");

            var apiInstance = new FlowAnalysisApi();

            try
            {
                // Retrieves a summary of all flow analyses stored
                FlowAnalysis_Output result = apiInstance.flowAnalysis();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FlowAnalysisApi.flowAnalysis: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: auth_ticket
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');

$api_instance = new Swagger\Client\Api\FlowAnalysisApi();

try {
    $result = $api_instance->flowAnalysis();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FlowAnalysisApi->flowAnalysis: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::FlowAnalysisApi;

# Configure API key authorization: auth_ticket
$WWW::SwaggerClient::Configuration::api_key->{'X-Auth-Token'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Auth-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::FlowAnalysisApi->new();

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

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: auth_ticket
swagger_client.configuration.api_key['X-Auth-Token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Auth-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.FlowAnalysisApi()


try: 
    # Retrieves a summary of all flow analyses stored
    api_response = api_instance.flow_analysis()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FlowAnalysisApi->flowAnalysis: %s\n" % e)

Parameters

Responses

Status: 200 - The request was successful. The result is contained in the response body.

Schema

Status: 401 - Not Authorized Yet, Credentials to be supplied

Status: 500 - The server could not fulfill the request.

Status: 501 - The server has not implemented the functionality required to fulfill the request.

getFullFlowAnalysisResult

Retrieves result of a previously requested flow analysis

Retrieves result of a previously requested flow analysis by its Flow Analysis id

/flow-analysis/{flowAnalysisId}

Usage and SDK Samples

Curl

curl -X GET -H "X-Auth-Token: [[apiKey]]" "http://{IP}:{PORT}/api/v1/flow-analysis/{flowAnalysisId}"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.FlowAnalysisApi;

import java.io.File;
import java.util.*;

public class FlowAnalysisApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: auth_ticket
        ApiKeyAuth auth_ticket = (ApiKeyAuth) defaultClient.getAuthentication("auth_ticket");
        auth_ticket.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //auth_ticket.setApiKeyPrefix("Token");

        FlowAnalysisApi apiInstance = new FlowAnalysisApi();
        String flowAnalysisId = flowAnalysisId_example; // String | Flow analysis request id
        try {
            FlowAnalysis_PathResponseResult result = apiInstance.getFullFlowAnalysisResult(flowAnalysisId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FlowAnalysisApi#getFullFlowAnalysisResult");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.FlowAnalysisApi;

public class FlowAnalysisApiExample {

    public static void main(String[] args) {
        FlowAnalysisApi apiInstance = new FlowAnalysisApi();
        String flowAnalysisId = flowAnalysisId_example; // String | Flow analysis request id
        try {
            FlowAnalysis_PathResponseResult result = apiInstance.getFullFlowAnalysisResult(flowAnalysisId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FlowAnalysisApi#getFullFlowAnalysisResult");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: auth_ticket)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Auth-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Auth-Token"];

String *flowAnalysisId = flowAnalysisId_example; // Flow analysis request id

FlowAnalysisApi *apiInstance = [[FlowAnalysisApi alloc] init];

// Retrieves result of a previously requested flow analysis
[apiInstance getFullFlowAnalysisResultWith:flowAnalysisId
              completionHandler: ^(FlowAnalysis_PathResponseResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var CiscoPacketTracerNorthboundApiForNetworkControllerDevice = require('cisco_packet_tracer_northbound_api_for_network_controller_device');
var defaultClient = CiscoPacketTracerNorthboundApiForNetworkControllerDevice.ApiClient.instance;

// Configure API key authorization: auth_ticket
var auth_ticket = defaultClient.authentications['auth_ticket'];
auth_ticket.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//auth_ticket.apiKeyPrefix['X-Auth-Token'] = "Token"

var api = new CiscoPacketTracerNorthboundApiForNetworkControllerDevice.FlowAnalysisApi()

var flowAnalysisId = flowAnalysisId_example; // {String} Flow analysis request id


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getFullFlowAnalysisResult(flowAnalysisId, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getFullFlowAnalysisResultExample
    {
        public void main()
        {
            
            // Configure API key authorization: auth_ticket
            Configuration.Default.ApiKey.Add("X-Auth-Token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Auth-Token", "Bearer");

            var apiInstance = new FlowAnalysisApi();
            var flowAnalysisId = flowAnalysisId_example;  // String | Flow analysis request id

            try
            {
                // Retrieves result of a previously requested flow analysis
                FlowAnalysis_PathResponseResult result = apiInstance.getFullFlowAnalysisResult(flowAnalysisId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FlowAnalysisApi.getFullFlowAnalysisResult: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: auth_ticket
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');

$api_instance = new Swagger\Client\Api\FlowAnalysisApi();
$flowAnalysisId = flowAnalysisId_example; // String | Flow analysis request id

try {
    $result = $api_instance->getFullFlowAnalysisResult($flowAnalysisId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FlowAnalysisApi->getFullFlowAnalysisResult: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::FlowAnalysisApi;

# Configure API key authorization: auth_ticket
$WWW::SwaggerClient::Configuration::api_key->{'X-Auth-Token'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Auth-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::FlowAnalysisApi->new();
my $flowAnalysisId = flowAnalysisId_example; # String | Flow analysis request id

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

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: auth_ticket
swagger_client.configuration.api_key['X-Auth-Token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Auth-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.FlowAnalysisApi()
flowAnalysisId = flowAnalysisId_example # String | Flow analysis request id


try: 
    # Retrieves result of a previously requested flow analysis
    api_response = api_instance.get_full_flow_analysis_result(flowAnalysisId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FlowAnalysisApi->getFullFlowAnalysisResult: %s\n" % e)

Parameters

Path parameters

Name	Description
flowAnalysisId*	String Flow analysis request id Required

Responses

Status: 200 - The request was successful. The result is contained in the response body.

Schema

Status: 401 - Not Authorized Yet, Credentials to be supplied

Status: 404 - No Resource Found

Status: 500 - The server could not fulfill the request.

Status: 501 - The server has not implemented the functionality required to fulfill the request.

initiateFlowAnalysis

Initiates a New Flow Analysis

Initiates a new flow analysis with periodic refresh and stat collection options. Returns a request id and a task id to get results and follow progress.

/flow-analysis

Usage and SDK Samples

Curl

curl -X POST -H "X-Auth-Token: [[apiKey]]" "http://{IP}:{PORT}/api/v1/flow-analysis"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.FlowAnalysisApi;

import java.io.File;
import java.util.*;

public class FlowAnalysisApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: auth_ticket
        ApiKeyAuth auth_ticket = (ApiKeyAuth) defaultClient.getAuthentication("auth_ticket");
        auth_ticket.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //auth_ticket.setApiKeyPrefix("Token");

        FlowAnalysisApi apiInstance = new FlowAnalysisApi();
        FlowAnalysis_Request flowAnalysisRequest = ; // FlowAnalysis_Request | 
        try {
            FlowAnalysis_RequestResultOutput result = apiInstance.initiateFlowAnalysis(flowAnalysisRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FlowAnalysisApi#initiateFlowAnalysis");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.FlowAnalysisApi;

public class FlowAnalysisApiExample {

    public static void main(String[] args) {
        FlowAnalysisApi apiInstance = new FlowAnalysisApi();
        FlowAnalysis_Request flowAnalysisRequest = ; // FlowAnalysis_Request | 
        try {
            FlowAnalysis_RequestResultOutput result = apiInstance.initiateFlowAnalysis(flowAnalysisRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FlowAnalysisApi#initiateFlowAnalysis");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: auth_ticket)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Auth-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Auth-Token"];

FlowAnalysis_Request *flowAnalysisRequest = ; //  (optional)

FlowAnalysisApi *apiInstance = [[FlowAnalysisApi alloc] init];

// Initiates a New Flow Analysis
[apiInstance initiateFlowAnalysisWith:flowAnalysisRequest
              completionHandler: ^(FlowAnalysis_RequestResultOutput output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var CiscoPacketTracerNorthboundApiForNetworkControllerDevice = require('cisco_packet_tracer_northbound_api_for_network_controller_device');
var defaultClient = CiscoPacketTracerNorthboundApiForNetworkControllerDevice.ApiClient.instance;

// Configure API key authorization: auth_ticket
var auth_ticket = defaultClient.authentications['auth_ticket'];
auth_ticket.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//auth_ticket.apiKeyPrefix['X-Auth-Token'] = "Token"

var api = new CiscoPacketTracerNorthboundApiForNetworkControllerDevice.FlowAnalysisApi()

var opts = { 
  'flowAnalysisRequest':  // {FlowAnalysis_Request} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.initiateFlowAnalysis(opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class initiateFlowAnalysisExample
    {
        public void main()
        {
            
            // Configure API key authorization: auth_ticket
            Configuration.Default.ApiKey.Add("X-Auth-Token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Auth-Token", "Bearer");

            var apiInstance = new FlowAnalysisApi();
            var flowAnalysisRequest = new FlowAnalysis_Request(); // FlowAnalysis_Request |  (optional) 

            try
            {
                // Initiates a New Flow Analysis
                FlowAnalysis_RequestResultOutput result = apiInstance.initiateFlowAnalysis(flowAnalysisRequest);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FlowAnalysisApi.initiateFlowAnalysis: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: auth_ticket
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');

$api_instance = new Swagger\Client\Api\FlowAnalysisApi();
$flowAnalysisRequest = ; // FlowAnalysis_Request | 

try {
    $result = $api_instance->initiateFlowAnalysis($flowAnalysisRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FlowAnalysisApi->initiateFlowAnalysis: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::FlowAnalysisApi;

# Configure API key authorization: auth_ticket
$WWW::SwaggerClient::Configuration::api_key->{'X-Auth-Token'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Auth-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::FlowAnalysisApi->new();
my $flowAnalysisRequest = WWW::SwaggerClient::Object::FlowAnalysis_Request->new(); # FlowAnalysis_Request | 

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

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: auth_ticket
swagger_client.configuration.api_key['X-Auth-Token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Auth-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.FlowAnalysisApi()
flowAnalysisRequest =  # FlowAnalysis_Request |  (optional)


try: 
    # Initiates a New Flow Analysis
    api_response = api_instance.initiate_flow_analysis(flowAnalysisRequest=flowAnalysisRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FlowAnalysisApi->initiateFlowAnalysis: %s\n" % e)

Parameters

Body parameters

Name	Description
flowAnalysisRequest

Responses

Status: 200 - The request was successful. The result is contained in the response body.

Schema

Status: 201 - The POST request was fulfilled and a new resource has been created. Information about the resource is in the response body.

Status: 400 - The client made a request that the server could not understand (for example, the request syntax is incorrect).

Status: 401 - Not Authorized Yet, Credentials to be supplied

Status: 500 - The server could not fulfill the request.

Status: 501 - The server has not implemented the functionality required to fulfill the request.

Network Wide Settings API

getNetworkWideSetting

Get the network wide settings

/wan/network-wide-setting

Usage and SDK Samples

Curl

curl -X GET -H "X-Auth-Token: [[apiKey]]" "http://{IP}:{PORT}/api/v1/wan/network-wide-setting"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.NetworkWideSettingApi;

import java.io.File;
import java.util.*;

public class NetworkWideSettingApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: auth_ticket
        ApiKeyAuth auth_ticket = (ApiKeyAuth) defaultClient.getAuthentication("auth_ticket");
        auth_ticket.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //auth_ticket.setApiKeyPrefix("Token");

        NetworkWideSettingApi apiInstance = new NetworkWideSettingApi();
        try {
            WAN_SystemSettingsResult result = apiInstance.getNetworkWideSetting();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NetworkWideSettingApi#getNetworkWideSetting");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.NetworkWideSettingApi;

public class NetworkWideSettingApiExample {

    public static void main(String[] args) {
        NetworkWideSettingApi apiInstance = new NetworkWideSettingApi();
        try {
            WAN_SystemSettingsResult result = apiInstance.getNetworkWideSetting();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NetworkWideSettingApi#getNetworkWideSetting");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: auth_ticket)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Auth-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Auth-Token"];


NetworkWideSettingApi *apiInstance = [[NetworkWideSettingApi alloc] init];

// Get the network wide settings
[apiInstance getNetworkWideSettingWithCompletionHandler: 
              ^(WAN_SystemSettingsResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var CiscoPacketTracerNorthboundApiForNetworkControllerDevice = require('cisco_packet_tracer_northbound_api_for_network_controller_device');
var defaultClient = CiscoPacketTracerNorthboundApiForNetworkControllerDevice.ApiClient.instance;

// Configure API key authorization: auth_ticket
var auth_ticket = defaultClient.authentications['auth_ticket'];
auth_ticket.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//auth_ticket.apiKeyPrefix['X-Auth-Token'] = "Token"

var api = new CiscoPacketTracerNorthboundApiForNetworkControllerDevice.NetworkWideSettingApi()

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getNetworkWideSetting(callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getNetworkWideSettingExample
    {
        public void main()
        {
            
            // Configure API key authorization: auth_ticket
            Configuration.Default.ApiKey.Add("X-Auth-Token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Auth-Token", "Bearer");

            var apiInstance = new NetworkWideSettingApi();

            try
            {
                // Get the network wide settings
                WAN_SystemSettingsResult result = apiInstance.getNetworkWideSetting();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling NetworkWideSettingApi.getNetworkWideSetting: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: auth_ticket
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');

$api_instance = new Swagger\Client\Api\NetworkWideSettingApi();

try {
    $result = $api_instance->getNetworkWideSetting();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling NetworkWideSettingApi->getNetworkWideSetting: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::NetworkWideSettingApi;

# Configure API key authorization: auth_ticket
$WWW::SwaggerClient::Configuration::api_key->{'X-Auth-Token'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Auth-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::NetworkWideSettingApi->new();

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

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: auth_ticket
swagger_client.configuration.api_key['X-Auth-Token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Auth-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.NetworkWideSettingApi()


try: 
    # Get the network wide settings
    api_response = api_instance.get_network_wide_setting()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling NetworkWideSettingApi->getNetworkWideSetting: %s\n" % e)

Parameters

Responses

Status: 200 - The request was successful. The result is containted in the response body.

Schema

Status: 401 - Not Authorized Yet, Credentials to be supplied

Status: 500 - The server could not fulfill the request.

Status: 501 - The server has not implemented the functionality required to fulfill the request.

updateNetworkWideSetting

Save and apply the network wide settings

Save and apply the network wide settings to managed devices. This functionality is only supported on devices running IOS-XE OS and Switch 2960-24TT.

/wan/network-wide-setting

Usage and SDK Samples

Curl

curl -X PUT -H "X-Auth-Token: [[apiKey]]" "http://{IP}:{PORT}/api/v1/wan/network-wide-setting"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.NetworkWideSettingApi;

import java.io.File;
import java.util.*;

public class NetworkWideSettingApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: auth_ticket
        ApiKeyAuth auth_ticket = (ApiKeyAuth) defaultClient.getAuthentication("auth_ticket");
        auth_ticket.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //auth_ticket.setApiKeyPrefix("Token");

        NetworkWideSettingApi apiInstance = new NetworkWideSettingApi();
        WAN_SystemSettings networkWideSetting = ; // WAN_SystemSettings | Network Wide Settings
        try {
            WAN_SystemSettingsResult result = apiInstance.updateNetworkWideSetting(networkWideSetting);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NetworkWideSettingApi#updateNetworkWideSetting");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.NetworkWideSettingApi;

public class NetworkWideSettingApiExample {

    public static void main(String[] args) {
        NetworkWideSettingApi apiInstance = new NetworkWideSettingApi();
        WAN_SystemSettings networkWideSetting = ; // WAN_SystemSettings | Network Wide Settings
        try {
            WAN_SystemSettingsResult result = apiInstance.updateNetworkWideSetting(networkWideSetting);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NetworkWideSettingApi#updateNetworkWideSetting");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: auth_ticket)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Auth-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Auth-Token"];

WAN_SystemSettings *networkWideSetting = ; // Network Wide Settings (optional)

NetworkWideSettingApi *apiInstance = [[NetworkWideSettingApi alloc] init];

// Save and apply the network wide settings
[apiInstance updateNetworkWideSettingWith:networkWideSetting
              completionHandler: ^(WAN_SystemSettingsResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var CiscoPacketTracerNorthboundApiForNetworkControllerDevice = require('cisco_packet_tracer_northbound_api_for_network_controller_device');
var defaultClient = CiscoPacketTracerNorthboundApiForNetworkControllerDevice.ApiClient.instance;

// Configure API key authorization: auth_ticket
var auth_ticket = defaultClient.authentications['auth_ticket'];
auth_ticket.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//auth_ticket.apiKeyPrefix['X-Auth-Token'] = "Token"

var api = new CiscoPacketTracerNorthboundApiForNetworkControllerDevice.NetworkWideSettingApi()

var opts = { 
  'networkWideSetting':  // {WAN_SystemSettings} Network Wide Settings
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateNetworkWideSetting(opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateNetworkWideSettingExample
    {
        public void main()
        {
            
            // Configure API key authorization: auth_ticket
            Configuration.Default.ApiKey.Add("X-Auth-Token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Auth-Token", "Bearer");

            var apiInstance = new NetworkWideSettingApi();
            var networkWideSetting = new WAN_SystemSettings(); // WAN_SystemSettings | Network Wide Settings (optional) 

            try
            {
                // Save and apply the network wide settings
                WAN_SystemSettingsResult result = apiInstance.updateNetworkWideSetting(networkWideSetting);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling NetworkWideSettingApi.updateNetworkWideSetting: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: auth_ticket
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');

$api_instance = new Swagger\Client\Api\NetworkWideSettingApi();
$networkWideSetting = ; // WAN_SystemSettings | Network Wide Settings

try {
    $result = $api_instance->updateNetworkWideSetting($networkWideSetting);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling NetworkWideSettingApi->updateNetworkWideSetting: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::NetworkWideSettingApi;

# Configure API key authorization: auth_ticket
$WWW::SwaggerClient::Configuration::api_key->{'X-Auth-Token'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Auth-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::NetworkWideSettingApi->new();
my $networkWideSetting = WWW::SwaggerClient::Object::WAN_SystemSettings->new(); # WAN_SystemSettings | Network Wide Settings

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

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: auth_ticket
swagger_client.configuration.api_key['X-Auth-Token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Auth-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.NetworkWideSettingApi()
networkWideSetting =  # WAN_SystemSettings | Network Wide Settings (optional)


try: 
    # Save and apply the network wide settings
    api_response = api_instance.update_network_wide_setting(networkWideSetting=networkWideSetting)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling NetworkWideSettingApi->updateNetworkWideSetting: %s\n" % e)

Parameters

Body parameters

Name	Description
networkWideSetting

Responses

Status: 200 - The request was successful. The result is containted in the response body.

Schema

Status: 400 - The client made a request that the server could not understand (for example, the request syntax is incorrect).

Status: 401 - Not Authorized Yet, Credentials to be supplied

Status: 500 - The server could not fulfill the request.

Status: 501 - The server has not implemented the functionality required to fulfill the request.

QoS API

addPolicy

Create policy(s)

Create a policy and apply it to managed devices. This functionality is only supported on devices running IOS-XE OS.

/policy

Usage and SDK Samples

Curl

curl -X POST -H "X-Auth-Token: [[apiKey]]" "http://{IP}:{PORT}/api/v1/policy"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.QosApi;

import java.io.File;
import java.util.*;

public class QosApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: auth_ticket
        ApiKeyAuth auth_ticket = (ApiKeyAuth) defaultClient.getAuthentication("auth_ticket");
        auth_ticket.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //auth_ticket.setApiKeyPrefix("Token");

        QosApi apiInstance = new QosApi();
        Policy policy = ; // Policy | Policy Object
        try {
            Common_BooleanResponse result = apiInstance.addPolicy(policy);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling QosApi#addPolicy");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.QosApi;

public class QosApiExample {

    public static void main(String[] args) {
        QosApi apiInstance = new QosApi();
        Policy policy = ; // Policy | Policy Object
        try {
            Common_BooleanResponse result = apiInstance.addPolicy(policy);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling QosApi#addPolicy");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: auth_ticket)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Auth-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Auth-Token"];

Policy *policy = ; // Policy Object

QosApi *apiInstance = [[QosApi alloc] init];

// Create policy(s)
[apiInstance addPolicyWith:policy
              completionHandler: ^(Common_BooleanResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var CiscoPacketTracerNorthboundApiForNetworkControllerDevice = require('cisco_packet_tracer_northbound_api_for_network_controller_device');
var defaultClient = CiscoPacketTracerNorthboundApiForNetworkControllerDevice.ApiClient.instance;

// Configure API key authorization: auth_ticket
var auth_ticket = defaultClient.authentications['auth_ticket'];
auth_ticket.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//auth_ticket.apiKeyPrefix['X-Auth-Token'] = "Token"

var api = new CiscoPacketTracerNorthboundApiForNetworkControllerDevice.QosApi()

var policy = ; // {Policy} Policy Object


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.addPolicy(policy, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class addPolicyExample
    {
        public void main()
        {
            
            // Configure API key authorization: auth_ticket
            Configuration.Default.ApiKey.Add("X-Auth-Token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Auth-Token", "Bearer");

            var apiInstance = new QosApi();
            var policy = new Policy(); // Policy | Policy Object

            try
            {
                // Create policy(s)
                Common_BooleanResponse result = apiInstance.addPolicy(policy);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling QosApi.addPolicy: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: auth_ticket
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');

$api_instance = new Swagger\Client\Api\QosApi();
$policy = ; // Policy | Policy Object

try {
    $result = $api_instance->addPolicy($policy);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling QosApi->addPolicy: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::QosApi;

# Configure API key authorization: auth_ticket
$WWW::SwaggerClient::Configuration::api_key->{'X-Auth-Token'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Auth-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::QosApi->new();
my $policy = WWW::SwaggerClient::Object::Policy->new(); # Policy | Policy Object

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

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: auth_ticket
swagger_client.configuration.api_key['X-Auth-Token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Auth-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.QosApi()
policy =  # Policy | Policy Object


try: 
    # Create policy(s)
    api_response = api_instance.add_policy(policy)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling QosApi->addPolicy: %s\n" % e)

Parameters

Body parameters

Name	Description
policy *

Responses

Status: 200 - This Request is OK

Schema

Status: 201 - The POST request was fulfilled and a new resource has been created. Information about the resource is in the response body.

Status: 400 - The client made a request that the server could not understand (for example, the request syntax is incorrect).

Status: 401 - Not Authorized Yet, Credentials to be supplied

Status: 500 - The server could not fulfill the request.

Status: 501 - The server has not implemented the functionality required to fulfill the request.

addPolicyTag

Create a policy tag

addPolicyTag

/policy/tag

Usage and SDK Samples

Curl

curl -X POST -H "X-Auth-Token: [[apiKey]]" "http://{IP}:{PORT}/api/v1/policy/tag"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.QosApi;

import java.io.File;
import java.util.*;

public class QosApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: auth_ticket
        ApiKeyAuth auth_ticket = (ApiKeyAuth) defaultClient.getAuthentication("auth_ticket");
        auth_ticket.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //auth_ticket.setApiKeyPrefix("Token");

        QosApi apiInstance = new QosApi();
        PolicyTagDTO policyTagDTO = ; // PolicyTagDTO | policyTagDTO
        try {
            Common_BooleanResponse result = apiInstance.addPolicyTag(policyTagDTO);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling QosApi#addPolicyTag");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.QosApi;

public class QosApiExample {

    public static void main(String[] args) {
        QosApi apiInstance = new QosApi();
        PolicyTagDTO policyTagDTO = ; // PolicyTagDTO | policyTagDTO
        try {
            Common_BooleanResponse result = apiInstance.addPolicyTag(policyTagDTO);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling QosApi#addPolicyTag");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: auth_ticket)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Auth-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Auth-Token"];

PolicyTagDTO *policyTagDTO = ; // policyTagDTO (optional)

QosApi *apiInstance = [[QosApi alloc] init];

// Create a policy tag
[apiInstance addPolicyTagWith:policyTagDTO
              completionHandler: ^(Common_BooleanResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var CiscoPacketTracerNorthboundApiForNetworkControllerDevice = require('cisco_packet_tracer_northbound_api_for_network_controller_device');
var defaultClient = CiscoPacketTracerNorthboundApiForNetworkControllerDevice.ApiClient.instance;

// Configure API key authorization: auth_ticket
var auth_ticket = defaultClient.authentications['auth_ticket'];
auth_ticket.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//auth_ticket.apiKeyPrefix['X-Auth-Token'] = "Token"

var api = new CiscoPacketTracerNorthboundApiForNetworkControllerDevice.QosApi()

var opts = { 
  'policyTagDTO':  // {PolicyTagDTO} policyTagDTO
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.addPolicyTag(opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class addPolicyTagExample
    {
        public void main()
        {
            
            // Configure API key authorization: auth_ticket
            Configuration.Default.ApiKey.Add("X-Auth-Token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Auth-Token", "Bearer");

            var apiInstance = new QosApi();
            var policyTagDTO = new PolicyTagDTO(); // PolicyTagDTO | policyTagDTO (optional) 

            try
            {
                // Create a policy tag
                Common_BooleanResponse result = apiInstance.addPolicyTag(policyTagDTO);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling QosApi.addPolicyTag: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: auth_ticket
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');

$api_instance = new Swagger\Client\Api\QosApi();
$policyTagDTO = ; // PolicyTagDTO | policyTagDTO

try {
    $result = $api_instance->addPolicyTag($policyTagDTO);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling QosApi->addPolicyTag: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::QosApi;

# Configure API key authorization: auth_ticket
$WWW::SwaggerClient::Configuration::api_key->{'X-Auth-Token'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Auth-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::QosApi->new();
my $policyTagDTO = WWW::SwaggerClient::Object::PolicyTagDTO->new(); # PolicyTagDTO | policyTagDTO

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

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: auth_ticket
swagger_client.configuration.api_key['X-Auth-Token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Auth-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.QosApi()
policyTagDTO =  # PolicyTagDTO | policyTagDTO (optional)


try: 
    # Create a policy tag
    api_response = api_instance.add_policy_tag(policyTagDTO=policyTagDTO)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling QosApi->addPolicyTag: %s\n" % e)

Parameters

Body parameters

Name	Description
policyTagDTO

Responses

Status: 200 - The request was successful. The result is contained in the response body.

Schema

Status: 201 - The POST request was fulfilled and a new resource has been created. Information about the resource is in the response body.

Status: 400 - The client made a request that the server could not understand (for example, the request syntax is incorrect).

Status: 401 - Not Authorized Yet, Credentials to be supplied

Status: 500 - The server could not fulfill the request.

Status: 501 - The server has not implemented the functionality required to fulfill the request.

addPolicyTagAssociation

Add a policy tag to network devices.

addPolicyTagAssociation

/policy/tag/association

Usage and SDK Samples

Curl

curl -X POST -H "X-Auth-Token: [[apiKey]]" "http://{IP}:{PORT}/api/v1/policy/tag/association"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.QosApi;

import java.io.File;
import java.util.*;

public class QosApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: auth_ticket
        ApiKeyAuth auth_ticket = (ApiKeyAuth) defaultClient.getAuthentication("auth_ticket");
        auth_ticket.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //auth_ticket.setApiKeyPrefix("Token");

        QosApi apiInstance = new QosApi();
        PolicyTagAssociationDTO policyTagAssociationDTO = ; // PolicyTagAssociationDTO | policyTagAssociationDTO
        try {
            Common_BooleanResponse result = apiInstance.addPolicyTagAssociation(policyTagAssociationDTO);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling QosApi#addPolicyTagAssociation");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.QosApi;

public class QosApiExample {

    public static void main(String[] args) {
        QosApi apiInstance = new QosApi();
        PolicyTagAssociationDTO policyTagAssociationDTO = ; // PolicyTagAssociationDTO | policyTagAssociationDTO
        try {
            Common_BooleanResponse result = apiInstance.addPolicyTagAssociation(policyTagAssociationDTO);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling QosApi#addPolicyTagAssociation");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: auth_ticket)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Auth-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Auth-Token"];

PolicyTagAssociationDTO *policyTagAssociationDTO = ; // policyTagAssociationDTO (optional)

QosApi *apiInstance = [[QosApi alloc] init];

// Add a policy tag to network devices.
[apiInstance addPolicyTagAssociationWith:policyTagAssociationDTO
              completionHandler: ^(Common_BooleanResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var CiscoPacketTracerNorthboundApiForNetworkControllerDevice = require('cisco_packet_tracer_northbound_api_for_network_controller_device');
var defaultClient = CiscoPacketTracerNorthboundApiForNetworkControllerDevice.ApiClient.instance;

// Configure API key authorization: auth_ticket
var auth_ticket = defaultClient.authentications['auth_ticket'];
auth_ticket.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//auth_ticket.apiKeyPrefix['X-Auth-Token'] = "Token"

var api = new CiscoPacketTracerNorthboundApiForNetworkControllerDevice.QosApi()

var opts = { 
  'policyTagAssociationDTO':  // {PolicyTagAssociationDTO} policyTagAssociationDTO
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.addPolicyTagAssociation(opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class addPolicyTagAssociationExample
    {
        public void main()
        {
            
            // Configure API key authorization: auth_ticket
            Configuration.Default.ApiKey.Add("X-Auth-Token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Auth-Token", "Bearer");

            var apiInstance = new QosApi();
            var policyTagAssociationDTO = new PolicyTagAssociationDTO(); // PolicyTagAssociationDTO | policyTagAssociationDTO (optional) 

            try
            {
                // Add a policy tag to network devices.
                Common_BooleanResponse result = apiInstance.addPolicyTagAssociation(policyTagAssociationDTO);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling QosApi.addPolicyTagAssociation: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: auth_ticket
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');

$api_instance = new Swagger\Client\Api\QosApi();
$policyTagAssociationDTO = ; // PolicyTagAssociationDTO | policyTagAssociationDTO

try {
    $result = $api_instance->addPolicyTagAssociation($policyTagAssociationDTO);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling QosApi->addPolicyTagAssociation: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::QosApi;

# Configure API key authorization: auth_ticket
$WWW::SwaggerClient::Configuration::api_key->{'X-Auth-Token'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Auth-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::QosApi->new();
my $policyTagAssociationDTO = WWW::SwaggerClient::Object::PolicyTagAssociationDTO->new(); # PolicyTagAssociationDTO | policyTagAssociationDTO

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

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: auth_ticket
swagger_client.configuration.api_key['X-Auth-Token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Auth-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.QosApi()
policyTagAssociationDTO =  # PolicyTagAssociationDTO | policyTagAssociationDTO (optional)


try: 
    # Add a policy tag to network devices.
    api_response = api_instance.add_policy_tag_association(policyTagAssociationDTO=policyTagAssociationDTO)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling QosApi->addPolicyTagAssociation: %s\n" % e)

Parameters

Body parameters

Name	Description
policyTagAssociationDTO

Responses

Status: 200 - The request was successful. The result is contained in the response body.

Schema

Status: 201 - The POST request was fulfilled and a new resource has been created. Information about the resource is in the response body.

Status: 400 - The client made a request that the server could not understand (for example, the request syntax is incorrect).

Status: 401 - Not Authorized Yet, Credentials to be supplied

Status: 500 - The server could not fulfill the request.

Status: 501 - The server has not implemented the functionality required to fulfill the request.

deletePolicy

Deletes a policy by its id

Delete a policy by id and remove it from managed devices. This functionality is only supported on devices running IOS-XE OS.

/policy/{id}

Usage and SDK Samples

Curl

curl -X DELETE -H "X-Auth-Token: [[apiKey]]" "http://{IP}:{PORT}/api/v1/policy/{id}"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.QosApi;

import java.io.File;
import java.util.*;

public class QosApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: auth_ticket
        ApiKeyAuth auth_ticket = (ApiKeyAuth) defaultClient.getAuthentication("auth_ticket");
        auth_ticket.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //auth_ticket.setApiKeyPrefix("Token");

        QosApi apiInstance = new QosApi();
        String id = id_example; // String | id
        try {
            Common_BooleanResponse result = apiInstance.deletePolicy(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling QosApi#deletePolicy");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.QosApi;

public class QosApiExample {

    public static void main(String[] args) {
        QosApi apiInstance = new QosApi();
        String id = id_example; // String | id
        try {
            Common_BooleanResponse result = apiInstance.deletePolicy(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling QosApi#deletePolicy");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: auth_ticket)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Auth-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Auth-Token"];

String *id = id_example; // id

QosApi *apiInstance = [[QosApi alloc] init];

// Deletes a policy by its id
[apiInstance deletePolicyWith:id
              completionHandler: ^(Common_BooleanResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var CiscoPacketTracerNorthboundApiForNetworkControllerDevice = require('cisco_packet_tracer_northbound_api_for_network_controller_device');
var defaultClient = CiscoPacketTracerNorthboundApiForNetworkControllerDevice.ApiClient.instance;

// Configure API key authorization: auth_ticket
var auth_ticket = defaultClient.authentications['auth_ticket'];
auth_ticket.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//auth_ticket.apiKeyPrefix['X-Auth-Token'] = "Token"

var api = new CiscoPacketTracerNorthboundApiForNetworkControllerDevice.QosApi()

var id = id_example; // {String} id


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deletePolicy(id, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deletePolicyExample
    {
        public void main()
        {
            
            // Configure API key authorization: auth_ticket
            Configuration.Default.ApiKey.Add("X-Auth-Token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Auth-Token", "Bearer");

            var apiInstance = new QosApi();
            var id = id_example;  // String | id

            try
            {
                // Deletes a policy by its id
                Common_BooleanResponse result = apiInstance.deletePolicy(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling QosApi.deletePolicy: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: auth_ticket
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');

$api_instance = new Swagger\Client\Api\QosApi();
$id = id_example; // String | id

try {
    $result = $api_instance->deletePolicy($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling QosApi->deletePolicy: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::QosApi;

# Configure API key authorization: auth_ticket
$WWW::SwaggerClient::Configuration::api_key->{'X-Auth-Token'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Auth-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::QosApi->new();
my $id = id_example; # String | id

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

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: auth_ticket
swagger_client.configuration.api_key['X-Auth-Token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Auth-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.QosApi()
id = id_example # String | id


try: 
    # Deletes a policy by its id
    api_response = api_instance.delete_policy(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling QosApi->deletePolicy: %s\n" % e)

Parameters

Path parameters

Name	Description
id*	String id Required

Responses

Status: 200 - This Request is OK

Schema

Status: 401 - Not Authorized Yet, Credentials to be supplied

Status: 404 - No Resource Found

Status: 500 - The server could not fulfill the request.

Status: 501 - The server has not implemented the functionality required to fulfill the request.

deletePolicyTag

Delete a policy tag.

deletePolicyTag

/policy/tag

Usage and SDK Samples

Curl

curl -X DELETE -H "X-Auth-Token: [[apiKey]]" "http://{IP}:{PORT}/api/v1/policy/tag?policyTag="

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.QosApi;

import java.io.File;
import java.util.*;

public class QosApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: auth_ticket
        ApiKeyAuth auth_ticket = (ApiKeyAuth) defaultClient.getAuthentication("auth_ticket");
        auth_ticket.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //auth_ticket.setApiKeyPrefix("Token");

        QosApi apiInstance = new QosApi();
        String policyTag = policyTag_example; // String | Policy Tag
        try {
            Common_BooleanResponse result = apiInstance.deletePolicyTag(policyTag);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling QosApi#deletePolicyTag");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.QosApi;

public class QosApiExample {

    public static void main(String[] args) {
        QosApi apiInstance = new QosApi();
        String policyTag = policyTag_example; // String | Policy Tag
        try {
            Common_BooleanResponse result = apiInstance.deletePolicyTag(policyTag);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling QosApi#deletePolicyTag");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: auth_ticket)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Auth-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Auth-Token"];

String *policyTag = policyTag_example; // Policy Tag

QosApi *apiInstance = [[QosApi alloc] init];

// Delete a policy tag.
[apiInstance deletePolicyTagWith:policyTag
              completionHandler: ^(Common_BooleanResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var CiscoPacketTracerNorthboundApiForNetworkControllerDevice = require('cisco_packet_tracer_northbound_api_for_network_controller_device');
var defaultClient = CiscoPacketTracerNorthboundApiForNetworkControllerDevice.ApiClient.instance;

// Configure API key authorization: auth_ticket
var auth_ticket = defaultClient.authentications['auth_ticket'];
auth_ticket.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//auth_ticket.apiKeyPrefix['X-Auth-Token'] = "Token"

var api = new CiscoPacketTracerNorthboundApiForNetworkControllerDevice.QosApi()

var policyTag = policyTag_example; // {String} Policy Tag


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deletePolicyTag(policyTag, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deletePolicyTagExample
    {
        public void main()
        {
            
            // Configure API key authorization: auth_ticket
            Configuration.Default.ApiKey.Add("X-Auth-Token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Auth-Token", "Bearer");

            var apiInstance = new QosApi();
            var policyTag = policyTag_example;  // String | Policy Tag

            try
            {
                // Delete a policy tag.
                Common_BooleanResponse result = apiInstance.deletePolicyTag(policyTag);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling QosApi.deletePolicyTag: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: auth_ticket
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');

$api_instance = new Swagger\Client\Api\QosApi();
$policyTag = policyTag_example; // String | Policy Tag

try {
    $result = $api_instance->deletePolicyTag($policyTag);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling QosApi->deletePolicyTag: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::QosApi;

# Configure API key authorization: auth_ticket
$WWW::SwaggerClient::Configuration::api_key->{'X-Auth-Token'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Auth-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::QosApi->new();
my $policyTag = policyTag_example; # String | Policy Tag

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

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: auth_ticket
swagger_client.configuration.api_key['X-Auth-Token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Auth-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.QosApi()
policyTag = policyTag_example # String | Policy Tag


try: 
    # Delete a policy tag.
    api_response = api_instance.delete_policy_tag(policyTag)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling QosApi->deletePolicyTag: %s\n" % e)

Parameters

Query parameters

Name	Description
policyTag*	String Policy Tag Required

Responses

Status: 200 - The request was successful. The result is contained in the response body.

Schema

Status: 400 - The client made a request that the server could not understand (for example, the request syntax is incorrect).

Status: 401 - Not Authorized Yet, Credentials to be supplied

Status: 404 - No Resource Found

Status: 500 - The server could not fulfill the request.

Status: 501 - The server has not implemented the functionality required to fulfill the request.

deletePolicyTagAssociation

Remove a policy tag from network device. If no networkDeviceId provided, all devices will be removed from the policy scope.

deletePolicyTagAssociation

/policy/tag/association

Usage and SDK Samples

Curl

curl -X DELETE -H "X-Auth-Token: [[apiKey]]" "http://{IP}:{PORT}/api/v1/policy/tag/association?policyTag=&networkDeviceId="

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.QosApi;

import java.io.File;
import java.util.*;

public class QosApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: auth_ticket
        ApiKeyAuth auth_ticket = (ApiKeyAuth) defaultClient.getAuthentication("auth_ticket");
        auth_ticket.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //auth_ticket.setApiKeyPrefix("Token");

        QosApi apiInstance = new QosApi();
        String policyTag = policyTag_example; // String | Policy Tag
        String networkDeviceId = networkDeviceId_example; // String | NetworkDeviceId
        try {
            Common_BooleanResponse result = apiInstance.deletePolicyTagAssociation(policyTag, networkDeviceId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling QosApi#deletePolicyTagAssociation");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.QosApi;

public class QosApiExample {

    public static void main(String[] args) {
        QosApi apiInstance = new QosApi();
        String policyTag = policyTag_example; // String | Policy Tag
        String networkDeviceId = networkDeviceId_example; // String | NetworkDeviceId
        try {
            Common_BooleanResponse result = apiInstance.deletePolicyTagAssociation(policyTag, networkDeviceId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling QosApi#deletePolicyTagAssociation");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: auth_ticket)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Auth-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Auth-Token"];

String *policyTag = policyTag_example; // Policy Tag
String *networkDeviceId = networkDeviceId_example; // NetworkDeviceId

QosApi *apiInstance = [[QosApi alloc] init];

// Remove a policy tag from network device. If no networkDeviceId provided, all devices will be removed from the policy scope.
[apiInstance deletePolicyTagAssociationWith:policyTag
    networkDeviceId:networkDeviceId
              completionHandler: ^(Common_BooleanResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var CiscoPacketTracerNorthboundApiForNetworkControllerDevice = require('cisco_packet_tracer_northbound_api_for_network_controller_device');
var defaultClient = CiscoPacketTracerNorthboundApiForNetworkControllerDevice.ApiClient.instance;

// Configure API key authorization: auth_ticket
var auth_ticket = defaultClient.authentications['auth_ticket'];
auth_ticket.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//auth_ticket.apiKeyPrefix['X-Auth-Token'] = "Token"

var api = new CiscoPacketTracerNorthboundApiForNetworkControllerDevice.QosApi()

var policyTag = policyTag_example; // {String} Policy Tag

var networkDeviceId = networkDeviceId_example; // {String} NetworkDeviceId


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deletePolicyTagAssociation(policyTag, networkDeviceId, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deletePolicyTagAssociationExample
    {
        public void main()
        {
            
            // Configure API key authorization: auth_ticket
            Configuration.Default.ApiKey.Add("X-Auth-Token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Auth-Token", "Bearer");

            var apiInstance = new QosApi();
            var policyTag = policyTag_example;  // String | Policy Tag
            var networkDeviceId = networkDeviceId_example;  // String | NetworkDeviceId

            try
            {
                // Remove a policy tag from network device. If no networkDeviceId provided, all devices will be removed from the policy scope.
                Common_BooleanResponse result = apiInstance.deletePolicyTagAssociation(policyTag, networkDeviceId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling QosApi.deletePolicyTagAssociation: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: auth_ticket
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');

$api_instance = new Swagger\Client\Api\QosApi();
$policyTag = policyTag_example; // String | Policy Tag
$networkDeviceId = networkDeviceId_example; // String | NetworkDeviceId

try {
    $result = $api_instance->deletePolicyTagAssociation($policyTag, $networkDeviceId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling QosApi->deletePolicyTagAssociation: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::QosApi;

# Configure API key authorization: auth_ticket
$WWW::SwaggerClient::Configuration::api_key->{'X-Auth-Token'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Auth-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::QosApi->new();
my $policyTag = policyTag_example; # String | Policy Tag
my $networkDeviceId = networkDeviceId_example; # String | NetworkDeviceId

eval { 
    my $result = $api_instance->deletePolicyTagAssociation(policyTag => $policyTag, networkDeviceId => $networkDeviceId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling QosApi->deletePolicyTagAssociation: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: auth_ticket
swagger_client.configuration.api_key['X-Auth-Token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Auth-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.QosApi()
policyTag = policyTag_example # String | Policy Tag
networkDeviceId = networkDeviceId_example # String | NetworkDeviceId


try: 
    # Remove a policy tag from network device. If no networkDeviceId provided, all devices will be removed from the policy scope.
    api_response = api_instance.delete_policy_tag_association(policyTag, networkDeviceId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling QosApi->deletePolicyTagAssociation: %s\n" % e)

Parameters

Query parameters

Name	Description
policyTag*	String Policy Tag Required
networkDeviceId*	String NetworkDeviceId Required

Responses

Status: 200 - The request was successful. The result is contained in the response body.

Schema

Status: 401 - Not Authorized Yet, Credentials to be supplied

Status: 404 - No Resource Found

Status: 500 - The server could not fulfill the request.

Status: 501 - The server has not implemented the functionality required to fulfill the request.

getFilterApplication

Retrieves applications based on name. When a name filter is not provided, all applications will be returned.

Get application(s) based on name.

/application

Usage and SDK Samples

Curl

curl -X GET -H "X-Auth-Token: [[apiKey]]" "http://{IP}:{PORT}/api/v1/application?name="

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.QosApi;

import java.io.File;
import java.util.*;

public class QosApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: auth_ticket
        ApiKeyAuth auth_ticket = (ApiKeyAuth) defaultClient.getAuthentication("auth_ticket");
        auth_ticket.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //auth_ticket.setApiKeyPrefix("Token");

        QosApi apiInstance = new QosApi();
        String name = name_example; // String | Retrieve application by name
        try {
            ApplicationListResult result = apiInstance.getFilterApplication(name);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling QosApi#getFilterApplication");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.QosApi;

public class QosApiExample {

    public static void main(String[] args) {
        QosApi apiInstance = new QosApi();
        String name = name_example; // String | Retrieve application by name
        try {
            ApplicationListResult result = apiInstance.getFilterApplication(name);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling QosApi#getFilterApplication");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: auth_ticket)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Auth-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Auth-Token"];

String *name = name_example; // Retrieve application by name (optional)

QosApi *apiInstance = [[QosApi alloc] init];

// Retrieves applications based on name. When a name filter is not provided, all applications will be returned.
[apiInstance getFilterApplicationWith:name
              completionHandler: ^(ApplicationListResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var CiscoPacketTracerNorthboundApiForNetworkControllerDevice = require('cisco_packet_tracer_northbound_api_for_network_controller_device');
var defaultClient = CiscoPacketTracerNorthboundApiForNetworkControllerDevice.ApiClient.instance;

// Configure API key authorization: auth_ticket
var auth_ticket = defaultClient.authentications['auth_ticket'];
auth_ticket.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//auth_ticket.apiKeyPrefix['X-Auth-Token'] = "Token"

var api = new CiscoPacketTracerNorthboundApiForNetworkControllerDevice.QosApi()

var opts = { 
  'name': name_example // {String} Retrieve application by name
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getFilterApplication(opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getFilterApplicationExample
    {
        public void main()
        {
            
            // Configure API key authorization: auth_ticket
            Configuration.Default.ApiKey.Add("X-Auth-Token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Auth-Token", "Bearer");

            var apiInstance = new QosApi();
            var name = name_example;  // String | Retrieve application by name (optional) 

            try
            {
                // Retrieves applications based on name. When a name filter is not provided, all applications will be returned.
                ApplicationListResult result = apiInstance.getFilterApplication(name);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling QosApi.getFilterApplication: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: auth_ticket
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');

$api_instance = new Swagger\Client\Api\QosApi();
$name = name_example; // String | Retrieve application by name

try {
    $result = $api_instance->getFilterApplication($name);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling QosApi->getFilterApplication: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::QosApi;

# Configure API key authorization: auth_ticket
$WWW::SwaggerClient::Configuration::api_key->{'X-Auth-Token'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Auth-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::QosApi->new();
my $name = name_example; # String | Retrieve application by name

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

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: auth_ticket
swagger_client.configuration.api_key['X-Auth-Token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Auth-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.QosApi()
name = name_example # String | Retrieve application by name (optional)


try: 
    # Retrieves applications based on name. When a name filter is not provided, all applications will be returned.
    api_response = api_instance.get_filter_application(name=name)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling QosApi->getFilterApplication: %s\n" % e)

Parameters

Query parameters

Name	Description
name	String Retrieve application by name

Responses

Status: 200 - This Request is OK

Schema

Status: 401 - Not Authorized Yet, Credentials to be supplied

Status: 404 - No Resource Found

Status: 500 - The server could not fulfill the request.

Status: 501 - The server has not implemented the functionality required to fulfill the request.

getFilterPolicies

Retrieves policies based on a given filter

Get policy(s) based on a given scope. If no scope is given, all policies will be returned.

/policy

Usage and SDK Samples

Curl

curl -X GET -H "X-Auth-Token: [[apiKey]]" "http://{IP}:{PORT}/api/v1/policy?policyScope="

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.QosApi;

import java.io.File;
import java.util.*;

public class QosApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: auth_ticket
        ApiKeyAuth auth_ticket = (ApiKeyAuth) defaultClient.getAuthentication("auth_ticket");
        auth_ticket.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //auth_ticket.setApiKeyPrefix("Token");

        QosApi apiInstance = new QosApi();
        String policyScope = policyScope_example; // String | Retrieve policies for a given scope
        try {
            PolicyListResult result = apiInstance.getFilterPolicies(policyScope);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling QosApi#getFilterPolicies");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.QosApi;

public class QosApiExample {

    public static void main(String[] args) {
        QosApi apiInstance = new QosApi();
        String policyScope = policyScope_example; // String | Retrieve policies for a given scope
        try {
            PolicyListResult result = apiInstance.getFilterPolicies(policyScope);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling QosApi#getFilterPolicies");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: auth_ticket)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Auth-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Auth-Token"];

String *policyScope = policyScope_example; // Retrieve policies for a given scope (optional)

QosApi *apiInstance = [[QosApi alloc] init];

// Retrieves policies based on a given filter
[apiInstance getFilterPoliciesWith:policyScope
              completionHandler: ^(PolicyListResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var CiscoPacketTracerNorthboundApiForNetworkControllerDevice = require('cisco_packet_tracer_northbound_api_for_network_controller_device');
var defaultClient = CiscoPacketTracerNorthboundApiForNetworkControllerDevice.ApiClient.instance;

// Configure API key authorization: auth_ticket
var auth_ticket = defaultClient.authentications['auth_ticket'];
auth_ticket.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//auth_ticket.apiKeyPrefix['X-Auth-Token'] = "Token"

var api = new CiscoPacketTracerNorthboundApiForNetworkControllerDevice.QosApi()

var opts = { 
  'policyScope': policyScope_example // {String} Retrieve policies for a given scope
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getFilterPolicies(opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getFilterPoliciesExample
    {
        public void main()
        {
            
            // Configure API key authorization: auth_ticket
            Configuration.Default.ApiKey.Add("X-Auth-Token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Auth-Token", "Bearer");

            var apiInstance = new QosApi();
            var policyScope = policyScope_example;  // String | Retrieve policies for a given scope (optional) 

            try
            {
                // Retrieves policies based on a given filter
                PolicyListResult result = apiInstance.getFilterPolicies(policyScope);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling QosApi.getFilterPolicies: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: auth_ticket
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');

$api_instance = new Swagger\Client\Api\QosApi();
$policyScope = policyScope_example; // String | Retrieve policies for a given scope

try {
    $result = $api_instance->getFilterPolicies($policyScope);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling QosApi->getFilterPolicies: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::QosApi;

# Configure API key authorization: auth_ticket
$WWW::SwaggerClient::Configuration::api_key->{'X-Auth-Token'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Auth-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::QosApi->new();
my $policyScope = policyScope_example; # String | Retrieve policies for a given scope

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

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: auth_ticket
swagger_client.configuration.api_key['X-Auth-Token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Auth-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.QosApi()
policyScope = policyScope_example # String | Retrieve policies for a given scope (optional)


try: 
    # Retrieves policies based on a given filter
    api_response = api_instance.get_filter_policies(policyScope=policyScope)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling QosApi->getFilterPolicies: %s\n" % e)

Parameters

Query parameters

Name	Description
policyScope	String Retrieve policies for a given scope

Responses

Status: 200 - This Request is OK

Schema

Status: 401 - Not Authorized Yet, Credentials to be supplied

Status: 500 - The server could not fulfill the request.

Status: 501 - The server has not implemented the functionality required to fulfill the request.

getPolicyById

Retrieves a policy based on its id

Get a policy by id

/policy/{id}

Usage and SDK Samples

Curl

curl -X GET -H "X-Auth-Token: [[apiKey]]" "http://{IP}:{PORT}/api/v1/policy/{id}"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.QosApi;

import java.io.File;
import java.util.*;

public class QosApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: auth_ticket
        ApiKeyAuth auth_ticket = (ApiKeyAuth) defaultClient.getAuthentication("auth_ticket");
        auth_ticket.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //auth_ticket.setApiKeyPrefix("Token");

        QosApi apiInstance = new QosApi();
        String id = id_example; // String | id
        try {
            PolicyResult result = apiInstance.getPolicyById(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling QosApi#getPolicyById");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.QosApi;

public class QosApiExample {

    public static void main(String[] args) {
        QosApi apiInstance = new QosApi();
        String id = id_example; // String | id
        try {
            PolicyResult result = apiInstance.getPolicyById(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling QosApi#getPolicyById");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: auth_ticket)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Auth-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Auth-Token"];

String *id = id_example; // id

QosApi *apiInstance = [[QosApi alloc] init];

// Retrieves a policy based on its id
[apiInstance getPolicyByIdWith:id
              completionHandler: ^(PolicyResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var CiscoPacketTracerNorthboundApiForNetworkControllerDevice = require('cisco_packet_tracer_northbound_api_for_network_controller_device');
var defaultClient = CiscoPacketTracerNorthboundApiForNetworkControllerDevice.ApiClient.instance;

// Configure API key authorization: auth_ticket
var auth_ticket = defaultClient.authentications['auth_ticket'];
auth_ticket.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//auth_ticket.apiKeyPrefix['X-Auth-Token'] = "Token"

var api = new CiscoPacketTracerNorthboundApiForNetworkControllerDevice.QosApi()

var id = id_example; // {String} id


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPolicyById(id, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getPolicyByIdExample
    {
        public void main()
        {
            
            // Configure API key authorization: auth_ticket
            Configuration.Default.ApiKey.Add("X-Auth-Token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Auth-Token", "Bearer");

            var apiInstance = new QosApi();
            var id = id_example;  // String | id

            try
            {
                // Retrieves a policy based on its id
                PolicyResult result = apiInstance.getPolicyById(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling QosApi.getPolicyById: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: auth_ticket
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');

$api_instance = new Swagger\Client\Api\QosApi();
$id = id_example; // String | id

try {
    $result = $api_instance->getPolicyById($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling QosApi->getPolicyById: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::QosApi;

# Configure API key authorization: auth_ticket
$WWW::SwaggerClient::Configuration::api_key->{'X-Auth-Token'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Auth-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::QosApi->new();
my $id = id_example; # String | id

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

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: auth_ticket
swagger_client.configuration.api_key['X-Auth-Token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Auth-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.QosApi()
id = id_example # String | id


try: 
    # Retrieves a policy based on its id
    api_response = api_instance.get_policy_by_id(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling QosApi->getPolicyById: %s\n" % e)

Parameters

Path parameters

Name	Description
id*	String id Required

Responses

Status: 200 - This Request is OK

Schema

Status: 401 - Not Authorized Yet, Credentials to be supplied

Status: 404 - No Resource Found

Status: 500 - The server could not fulfill the request.

Status: 501 - The server has not implemented the functionality required to fulfill the request.

getPolicyTagAssociation

Retrieves all policy tag association based a given network device and a given policy tag filter. If no policy tag nor network device provided as filter, all policy tag associations will be returned.

getPolicyTagAssociation

/policy/tag/association

Usage and SDK Samples

Curl

curl -X GET -H "X-Auth-Token: [[apiKey]]" "http://{IP}:{PORT}/api/v1/policy/tag/association?policyTag=&networkDeviceId="

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.QosApi;

import java.io.File;
import java.util.*;

public class QosApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: auth_ticket
        ApiKeyAuth auth_ticket = (ApiKeyAuth) defaultClient.getAuthentication("auth_ticket");
        auth_ticket.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //auth_ticket.setApiKeyPrefix("Token");

        QosApi apiInstance = new QosApi();
        String policyTag = policyTag_example; // String | Policy Tag
        String networkDeviceId = networkDeviceId_example; // String | Network device Id
        try {
            PolicyTagAssociationListResult result = apiInstance.getPolicyTagAssociation(policyTag, networkDeviceId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling QosApi#getPolicyTagAssociation");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.QosApi;

public class QosApiExample {

    public static void main(String[] args) {
        QosApi apiInstance = new QosApi();
        String policyTag = policyTag_example; // String | Policy Tag
        String networkDeviceId = networkDeviceId_example; // String | Network device Id
        try {
            PolicyTagAssociationListResult result = apiInstance.getPolicyTagAssociation(policyTag, networkDeviceId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling QosApi#getPolicyTagAssociation");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: auth_ticket)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Auth-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Auth-Token"];

String *policyTag = policyTag_example; // Policy Tag (optional)
String *networkDeviceId = networkDeviceId_example; // Network device Id (optional)

QosApi *apiInstance = [[QosApi alloc] init];

// Retrieves all policy tag association based a given network device and a given policy tag filter. If no policy tag nor network device provided as filter, all policy tag associations will be returned.
[apiInstance getPolicyTagAssociationWith:policyTag
    networkDeviceId:networkDeviceId
              completionHandler: ^(PolicyTagAssociationListResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var CiscoPacketTracerNorthboundApiForNetworkControllerDevice = require('cisco_packet_tracer_northbound_api_for_network_controller_device');
var defaultClient = CiscoPacketTracerNorthboundApiForNetworkControllerDevice.ApiClient.instance;

// Configure API key authorization: auth_ticket
var auth_ticket = defaultClient.authentications['auth_ticket'];
auth_ticket.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//auth_ticket.apiKeyPrefix['X-Auth-Token'] = "Token"

var api = new CiscoPacketTracerNorthboundApiForNetworkControllerDevice.QosApi()

var opts = { 
  'policyTag': policyTag_example, // {String} Policy Tag
  'networkDeviceId': networkDeviceId_example // {String} Network device Id
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPolicyTagAssociation(opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getPolicyTagAssociationExample
    {
        public void main()
        {
            
            // Configure API key authorization: auth_ticket
            Configuration.Default.ApiKey.Add("X-Auth-Token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Auth-Token", "Bearer");

            var apiInstance = new QosApi();
            var policyTag = policyTag_example;  // String | Policy Tag (optional) 
            var networkDeviceId = networkDeviceId_example;  // String | Network device Id (optional) 

            try
            {
                // Retrieves all policy tag association based a given network device and a given policy tag filter. If no policy tag nor network device provided as filter, all policy tag associations will be returned.
                PolicyTagAssociationListResult result = apiInstance.getPolicyTagAssociation(policyTag, networkDeviceId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling QosApi.getPolicyTagAssociation: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: auth_ticket
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');

$api_instance = new Swagger\Client\Api\QosApi();
$policyTag = policyTag_example; // String | Policy Tag
$networkDeviceId = networkDeviceId_example; // String | Network device Id

try {
    $result = $api_instance->getPolicyTagAssociation($policyTag, $networkDeviceId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling QosApi->getPolicyTagAssociation: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::QosApi;

# Configure API key authorization: auth_ticket
$WWW::SwaggerClient::Configuration::api_key->{'X-Auth-Token'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Auth-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::QosApi->new();
my $policyTag = policyTag_example; # String | Policy Tag
my $networkDeviceId = networkDeviceId_example; # String | Network device Id

eval { 
    my $result = $api_instance->getPolicyTagAssociation(policyTag => $policyTag, networkDeviceId => $networkDeviceId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling QosApi->getPolicyTagAssociation: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: auth_ticket
swagger_client.configuration.api_key['X-Auth-Token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Auth-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.QosApi()
policyTag = policyTag_example # String | Policy Tag (optional)
networkDeviceId = networkDeviceId_example # String | Network device Id (optional)


try: 
    # Retrieves all policy tag association based a given network device and a given policy tag filter. If no policy tag nor network device provided as filter, all policy tag associations will be returned.
    api_response = api_instance.get_policy_tag_association(policyTag=policyTag, networkDeviceId=networkDeviceId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling QosApi->getPolicyTagAssociation: %s\n" % e)

Parameters

Query parameters

Name	Description
policyTag	String Policy Tag
networkDeviceId	String Network device Id

Responses

Status: 200 - The request was successful. The result is contained in the response body.

Schema

Status: 401 - Not Authorized Yet, Credentials to be supplied

Status: 500 - The server could not fulfill the request.

Status: 501 - The server has not implemented the functionality required to fulfill the request.

getPolicyTagAssociationNetworkDevices

Retrieves network devices in policy tags based on filters.

/policy/tag/association/network-device

Usage and SDK Samples

Curl

curl -X GET -H "X-Auth-Token: [[apiKey]]" "http://{IP}:{PORT}/api/v1/policy/tag/association/network-device?deviceName=&deviceIp="

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.QosApi;

import java.io.File;
import java.util.*;

public class QosApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: auth_ticket
        ApiKeyAuth auth_ticket = (ApiKeyAuth) defaultClient.getAuthentication("auth_ticket");
        auth_ticket.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //auth_ticket.setApiKeyPrefix("Token");

        QosApi apiInstance = new QosApi();
        String deviceName = deviceName_example; // String | The name of the device.
        String deviceIp = deviceIp_example; // String | The ip address of the device.
        try {
            PolicyTagAssociationDeviceListResult result = apiInstance.getPolicyTagAssociationNetworkDevices(deviceName, deviceIp);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling QosApi#getPolicyTagAssociationNetworkDevices");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.QosApi;

public class QosApiExample {

    public static void main(String[] args) {
        QosApi apiInstance = new QosApi();
        String deviceName = deviceName_example; // String | The name of the device.
        String deviceIp = deviceIp_example; // String | The ip address of the device.
        try {
            PolicyTagAssociationDeviceListResult result = apiInstance.getPolicyTagAssociationNetworkDevices(deviceName, deviceIp);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling QosApi#getPolicyTagAssociationNetworkDevices");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: auth_ticket)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Auth-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Auth-Token"];

String *deviceName = deviceName_example; // The name of the device. (optional)
String *deviceIp = deviceIp_example; // The ip address of the device. (optional)

QosApi *apiInstance = [[QosApi alloc] init];

// Retrieves network devices in policy tags based on filters.
[apiInstance getPolicyTagAssociationNetworkDevicesWith:deviceName
    deviceIp:deviceIp
              completionHandler: ^(PolicyTagAssociationDeviceListResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var CiscoPacketTracerNorthboundApiForNetworkControllerDevice = require('cisco_packet_tracer_northbound_api_for_network_controller_device');
var defaultClient = CiscoPacketTracerNorthboundApiForNetworkControllerDevice.ApiClient.instance;

// Configure API key authorization: auth_ticket
var auth_ticket = defaultClient.authentications['auth_ticket'];
auth_ticket.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//auth_ticket.apiKeyPrefix['X-Auth-Token'] = "Token"

var api = new CiscoPacketTracerNorthboundApiForNetworkControllerDevice.QosApi()

var opts = { 
  'deviceName': deviceName_example, // {String} The name of the device.
  'deviceIp': deviceIp_example // {String} The ip address of the device.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPolicyTagAssociationNetworkDevices(opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getPolicyTagAssociationNetworkDevicesExample
    {
        public void main()
        {
            
            // Configure API key authorization: auth_ticket
            Configuration.Default.ApiKey.Add("X-Auth-Token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Auth-Token", "Bearer");

            var apiInstance = new QosApi();
            var deviceName = deviceName_example;  // String | The name of the device. (optional) 
            var deviceIp = deviceIp_example;  // String | The ip address of the device. (optional) 

            try
            {
                // Retrieves network devices in policy tags based on filters.
                PolicyTagAssociationDeviceListResult result = apiInstance.getPolicyTagAssociationNetworkDevices(deviceName, deviceIp);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling QosApi.getPolicyTagAssociationNetworkDevices: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: auth_ticket
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');

$api_instance = new Swagger\Client\Api\QosApi();
$deviceName = deviceName_example; // String | The name of the device.
$deviceIp = deviceIp_example; // String | The ip address of the device.

try {
    $result = $api_instance->getPolicyTagAssociationNetworkDevices($deviceName, $deviceIp);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling QosApi->getPolicyTagAssociationNetworkDevices: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::QosApi;

# Configure API key authorization: auth_ticket
$WWW::SwaggerClient::Configuration::api_key->{'X-Auth-Token'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Auth-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::QosApi->new();
my $deviceName = deviceName_example; # String | The name of the device.
my $deviceIp = deviceIp_example; # String | The ip address of the device.

eval { 
    my $result = $api_instance->getPolicyTagAssociationNetworkDevices(deviceName => $deviceName, deviceIp => $deviceIp);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling QosApi->getPolicyTagAssociationNetworkDevices: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: auth_ticket
swagger_client.configuration.api_key['X-Auth-Token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Auth-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.QosApi()
deviceName = deviceName_example # String | The name of the device. (optional)
deviceIp = deviceIp_example # String | The ip address of the device. (optional)


try: 
    # Retrieves network devices in policy tags based on filters.
    api_response = api_instance.get_policy_tag_association_network_devices(deviceName=deviceName, deviceIp=deviceIp)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling QosApi->getPolicyTagAssociationNetworkDevices: %s\n" % e)

Parameters

Query parameters

Name	Description
deviceName	String The name of the device.
deviceIp	String The ip address of the device.

Responses

Status: 200 - The request was successful. The result is contained in the response body.

Schema

Status: 401 - Not Authorized Yet, Credentials to be supplied

Status: 500 - The server could not fulfill the request.

Status: 501 - The server has not implemented the functionality required to fulfill the request.

getPolicyTagAssociationNetworkDevicesCount

Retrieves the number of network devices in policy tags based on filters.

/policy/tag/association/network-device/count

Usage and SDK Samples

Curl

curl -X GET -H "X-Auth-Token: [[apiKey]]" "http://{IP}:{PORT}/api/v1/policy/tag/association/network-device/count?deviceName=&deviceIp="

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.QosApi;

import java.io.File;
import java.util.*;

public class QosApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: auth_ticket
        ApiKeyAuth auth_ticket = (ApiKeyAuth) defaultClient.getAuthentication("auth_ticket");
        auth_ticket.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //auth_ticket.setApiKeyPrefix("Token");

        QosApi apiInstance = new QosApi();
        String deviceName = deviceName_example; // String | The name of the device.
        String deviceIp = deviceIp_example; // String | The ip address of the device.
        try {
            CountResult result = apiInstance.getPolicyTagAssociationNetworkDevicesCount(deviceName, deviceIp);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling QosApi#getPolicyTagAssociationNetworkDevicesCount");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.QosApi;

public class QosApiExample {

    public static void main(String[] args) {
        QosApi apiInstance = new QosApi();
        String deviceName = deviceName_example; // String | The name of the device.
        String deviceIp = deviceIp_example; // String | The ip address of the device.
        try {
            CountResult result = apiInstance.getPolicyTagAssociationNetworkDevicesCount(deviceName, deviceIp);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling QosApi#getPolicyTagAssociationNetworkDevicesCount");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: auth_ticket)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Auth-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Auth-Token"];

String *deviceName = deviceName_example; // The name of the device. (optional)
String *deviceIp = deviceIp_example; // The ip address of the device. (optional)

QosApi *apiInstance = [[QosApi alloc] init];

// Retrieves the number of network devices in policy tags based on filters.
[apiInstance getPolicyTagAssociationNetworkDevicesCountWith:deviceName
    deviceIp:deviceIp
              completionHandler: ^(CountResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var CiscoPacketTracerNorthboundApiForNetworkControllerDevice = require('cisco_packet_tracer_northbound_api_for_network_controller_device');
var defaultClient = CiscoPacketTracerNorthboundApiForNetworkControllerDevice.ApiClient.instance;

// Configure API key authorization: auth_ticket
var auth_ticket = defaultClient.authentications['auth_ticket'];
auth_ticket.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//auth_ticket.apiKeyPrefix['X-Auth-Token'] = "Token"

var api = new CiscoPacketTracerNorthboundApiForNetworkControllerDevice.QosApi()

var opts = { 
  'deviceName': deviceName_example, // {String} The name of the device.
  'deviceIp': deviceIp_example // {String} The ip address of the device.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPolicyTagAssociationNetworkDevicesCount(opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getPolicyTagAssociationNetworkDevicesCountExample
    {
        public void main()
        {
            
            // Configure API key authorization: auth_ticket
            Configuration.Default.ApiKey.Add("X-Auth-Token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Auth-Token", "Bearer");

            var apiInstance = new QosApi();
            var deviceName = deviceName_example;  // String | The name of the device. (optional) 
            var deviceIp = deviceIp_example;  // String | The ip address of the device. (optional) 

            try
            {
                // Retrieves the number of network devices in policy tags based on filters.
                CountResult result = apiInstance.getPolicyTagAssociationNetworkDevicesCount(deviceName, deviceIp);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling QosApi.getPolicyTagAssociationNetworkDevicesCount: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: auth_ticket
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');

$api_instance = new Swagger\Client\Api\QosApi();
$deviceName = deviceName_example; // String | The name of the device.
$deviceIp = deviceIp_example; // String | The ip address of the device.

try {
    $result = $api_instance->getPolicyTagAssociationNetworkDevicesCount($deviceName, $deviceIp);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling QosApi->getPolicyTagAssociationNetworkDevicesCount: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::QosApi;

# Configure API key authorization: auth_ticket
$WWW::SwaggerClient::Configuration::api_key->{'X-Auth-Token'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Auth-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::QosApi->new();
my $deviceName = deviceName_example; # String | The name of the device.
my $deviceIp = deviceIp_example; # String | The ip address of the device.

eval { 
    my $result = $api_instance->getPolicyTagAssociationNetworkDevicesCount(deviceName => $deviceName, deviceIp => $deviceIp);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling QosApi->getPolicyTagAssociationNetworkDevicesCount: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: auth_ticket
swagger_client.configuration.api_key['X-Auth-Token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Auth-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.QosApi()
deviceName = deviceName_example # String | The name of the device. (optional)
deviceIp = deviceIp_example # String | The ip address of the device. (optional)


try: 
    # Retrieves the number of network devices in policy tags based on filters.
    api_response = api_instance.get_policy_tag_association_network_devices_count(deviceName=deviceName, deviceIp=deviceIp)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling QosApi->getPolicyTagAssociationNetworkDevicesCount: %s\n" % e)

Parameters

Query parameters

Name	Description
deviceName	String The name of the device.
deviceIp	String The ip address of the device.

Responses

Status: 200 - The request was successful. The result is contained in the response body.

Schema

Status: 401 - Not Authorized Yet, Credentials to be supplied

Status: 500 - The server could not fulfill the request.

Status: 501 - The server has not implemented the functionality required to fulfill the request.

getPolicyTags

Retrieves policy tags

getPolicyTags

/policy/tag

Usage and SDK Samples

Curl

curl -X GET -H "X-Auth-Token: [[apiKey]]" "http://{IP}:{PORT}/api/v1/policy/tag"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.QosApi;

import java.io.File;
import java.util.*;

public class QosApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: auth_ticket
        ApiKeyAuth auth_ticket = (ApiKeyAuth) defaultClient.getAuthentication("auth_ticket");
        auth_ticket.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //auth_ticket.setApiKeyPrefix("Token");

        QosApi apiInstance = new QosApi();
        try {
            PolicyTagListResult result = apiInstance.getPolicyTags();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling QosApi#getPolicyTags");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.QosApi;

public class QosApiExample {

    public static void main(String[] args) {
        QosApi apiInstance = new QosApi();
        try {
            PolicyTagListResult result = apiInstance.getPolicyTags();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling QosApi#getPolicyTags");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: auth_ticket)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Auth-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Auth-Token"];


QosApi *apiInstance = [[QosApi alloc] init];

// Retrieves policy tags
[apiInstance getPolicyTagsWithCompletionHandler: 
              ^(PolicyTagListResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var CiscoPacketTracerNorthboundApiForNetworkControllerDevice = require('cisco_packet_tracer_northbound_api_for_network_controller_device');
var defaultClient = CiscoPacketTracerNorthboundApiForNetworkControllerDevice.ApiClient.instance;

// Configure API key authorization: auth_ticket
var auth_ticket = defaultClient.authentications['auth_ticket'];
auth_ticket.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//auth_ticket.apiKeyPrefix['X-Auth-Token'] = "Token"

var api = new CiscoPacketTracerNorthboundApiForNetworkControllerDevice.QosApi()

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPolicyTags(callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getPolicyTagsExample
    {
        public void main()
        {
            
            // Configure API key authorization: auth_ticket
            Configuration.Default.ApiKey.Add("X-Auth-Token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Auth-Token", "Bearer");

            var apiInstance = new QosApi();

            try
            {
                // Retrieves policy tags
                PolicyTagListResult result = apiInstance.getPolicyTags();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling QosApi.getPolicyTags: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: auth_ticket
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');

$api_instance = new Swagger\Client\Api\QosApi();

try {
    $result = $api_instance->getPolicyTags();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling QosApi->getPolicyTags: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::QosApi;

# Configure API key authorization: auth_ticket
$WWW::SwaggerClient::Configuration::api_key->{'X-Auth-Token'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Auth-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::QosApi->new();

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

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: auth_ticket
swagger_client.configuration.api_key['X-Auth-Token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Auth-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.QosApi()


try: 
    # Retrieves policy tags
    api_response = api_instance.get_policy_tags()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling QosApi->getPolicyTags: %s\n" % e)

Parameters

Responses

Status: 200 - The request was successful. The result is contained in the response body.

Schema

Status: 401 - Not Authorized Yet, Credentials to be supplied

Status: 500 - The server could not fulfill the request.

Status: 501 - The server has not implemented the functionality required to fulfill the request.

getPolicyTagsCount

Retrieves the number of policy tags

getPolicyTagsCount

/policy/tag/count

Usage and SDK Samples

Curl

curl -X GET -H "X-Auth-Token: [[apiKey]]" "http://{IP}:{PORT}/api/v1/policy/tag/count"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.QosApi;

import java.io.File;
import java.util.*;

public class QosApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: auth_ticket
        ApiKeyAuth auth_ticket = (ApiKeyAuth) defaultClient.getAuthentication("auth_ticket");
        auth_ticket.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //auth_ticket.setApiKeyPrefix("Token");

        QosApi apiInstance = new QosApi();
        try {
            CountResult result = apiInstance.getPolicyTagsCount();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling QosApi#getPolicyTagsCount");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.QosApi;

public class QosApiExample {

    public static void main(String[] args) {
        QosApi apiInstance = new QosApi();
        try {
            CountResult result = apiInstance.getPolicyTagsCount();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling QosApi#getPolicyTagsCount");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: auth_ticket)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Auth-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Auth-Token"];


QosApi *apiInstance = [[QosApi alloc] init];

// Retrieves the number of policy tags
[apiInstance getPolicyTagsCountWithCompletionHandler: 
              ^(CountResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var CiscoPacketTracerNorthboundApiForNetworkControllerDevice = require('cisco_packet_tracer_northbound_api_for_network_controller_device');
var defaultClient = CiscoPacketTracerNorthboundApiForNetworkControllerDevice.ApiClient.instance;

// Configure API key authorization: auth_ticket
var auth_ticket = defaultClient.authentications['auth_ticket'];
auth_ticket.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//auth_ticket.apiKeyPrefix['X-Auth-Token'] = "Token"

var api = new CiscoPacketTracerNorthboundApiForNetworkControllerDevice.QosApi()

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPolicyTagsCount(callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getPolicyTagsCountExample
    {
        public void main()
        {
            
            // Configure API key authorization: auth_ticket
            Configuration.Default.ApiKey.Add("X-Auth-Token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Auth-Token", "Bearer");

            var apiInstance = new QosApi();

            try
            {
                // Retrieves the number of policy tags
                CountResult result = apiInstance.getPolicyTagsCount();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling QosApi.getPolicyTagsCount: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: auth_ticket
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');

$api_instance = new Swagger\Client\Api\QosApi();

try {
    $result = $api_instance->getPolicyTagsCount();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling QosApi->getPolicyTagsCount: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::QosApi;

# Configure API key authorization: auth_ticket
$WWW::SwaggerClient::Configuration::api_key->{'X-Auth-Token'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Auth-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::QosApi->new();

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

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: auth_ticket
swagger_client.configuration.api_key['X-Auth-Token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Auth-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.QosApi()


try: 
    # Retrieves the number of policy tags
    api_response = api_instance.get_policy_tags_count()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling QosApi->getPolicyTagsCount: %s\n" % e)

Parameters

Responses

Status: 200 - The request was successful. The result is contained in the response body.

Schema

Status: 401 - Not Authorized Yet, Credentials to be supplied

Status: 500 - The server could not fulfill the request.

Status: 501 - The server has not implemented the functionality required to fulfill the request.

updatePolicy

Update policy(s)

Update a policy and apply it to managed devices. This functionality is only supported on devices running IOS-XE OS.

/policy/{id}

Usage and SDK Samples

Curl

curl -X PUT -H "X-Auth-Token: [[apiKey]]" "http://{IP}:{PORT}/api/v1/policy/{id}"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.QosApi;

import java.io.File;
import java.util.*;

public class QosApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: auth_ticket
        ApiKeyAuth auth_ticket = (ApiKeyAuth) defaultClient.getAuthentication("auth_ticket");
        auth_ticket.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //auth_ticket.setApiKeyPrefix("Token");

        QosApi apiInstance = new QosApi();
        String id = id_example; // String | id
        PolicyResource policyResource = ; // PolicyResource | Policy Resource
        try {
            Common_BooleanResponse result = apiInstance.updatePolicy(id, policyResource);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling QosApi#updatePolicy");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.QosApi;

public class QosApiExample {

    public static void main(String[] args) {
        QosApi apiInstance = new QosApi();
        String id = id_example; // String | id
        PolicyResource policyResource = ; // PolicyResource | Policy Resource
        try {
            Common_BooleanResponse result = apiInstance.updatePolicy(id, policyResource);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling QosApi#updatePolicy");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: auth_ticket)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Auth-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Auth-Token"];

String *id = id_example; // id
PolicyResource *policyResource = ; // Policy Resource

QosApi *apiInstance = [[QosApi alloc] init];

// Update policy(s)
[apiInstance updatePolicyWith:id
    policyResource:policyResource
              completionHandler: ^(Common_BooleanResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var CiscoPacketTracerNorthboundApiForNetworkControllerDevice = require('cisco_packet_tracer_northbound_api_for_network_controller_device');
var defaultClient = CiscoPacketTracerNorthboundApiForNetworkControllerDevice.ApiClient.instance;

// Configure API key authorization: auth_ticket
var auth_ticket = defaultClient.authentications['auth_ticket'];
auth_ticket.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//auth_ticket.apiKeyPrefix['X-Auth-Token'] = "Token"

var api = new CiscoPacketTracerNorthboundApiForNetworkControllerDevice.QosApi()

var id = id_example; // {String} id

var policyResource = ; // {PolicyResource} Policy Resource


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updatePolicy(id, policyResource, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updatePolicyExample
    {
        public void main()
        {
            
            // Configure API key authorization: auth_ticket
            Configuration.Default.ApiKey.Add("X-Auth-Token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Auth-Token", "Bearer");

            var apiInstance = new QosApi();
            var id = id_example;  // String | id
            var policyResource = new PolicyResource(); // PolicyResource | Policy Resource

            try
            {
                // Update policy(s)
                Common_BooleanResponse result = apiInstance.updatePolicy(id, policyResource);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling QosApi.updatePolicy: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: auth_ticket
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');

$api_instance = new Swagger\Client\Api\QosApi();
$id = id_example; // String | id
$policyResource = ; // PolicyResource | Policy Resource

try {
    $result = $api_instance->updatePolicy($id, $policyResource);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling QosApi->updatePolicy: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::QosApi;

# Configure API key authorization: auth_ticket
$WWW::SwaggerClient::Configuration::api_key->{'X-Auth-Token'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Auth-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::QosApi->new();
my $id = id_example; # String | id
my $policyResource = WWW::SwaggerClient::Object::PolicyResource->new(); # PolicyResource | Policy Resource

eval { 
    my $result = $api_instance->updatePolicy(id => $id, policyResource => $policyResource);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling QosApi->updatePolicy: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: auth_ticket
swagger_client.configuration.api_key['X-Auth-Token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Auth-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.QosApi()
id = id_example # String | id
policyResource =  # PolicyResource | Policy Resource


try: 
    # Update policy(s)
    api_response = api_instance.update_policy(id, policyResource)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling QosApi->updatePolicy: %s\n" % e)

Parameters

Path parameters

Name	Description
id*	String id Required

Body parameters

Name	Description
policyResource *

Responses

Status: 200 - This Request is OK

Schema

Status: 400 - The client made a request that the server could not understand (for example, the request syntax is incorrect).

Status: 401 - Not Authorized Yet, Credentials to be supplied

Status: 500 - The server could not fulfill the request.

Status: 501 - The server has not implemented the functionality required to fulfill the request.

Topology API

getPhysicalTopology

This method is used to obtain the raw physical topology

/topology/physical-topology

Usage and SDK Samples

Curl

curl -X GET -H "X-Auth-Token: [[apiKey]]" "http://{IP}:{PORT}/api/v1/topology/physical-topology"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TopologyApi;

import java.io.File;
import java.util.*;

public class TopologyApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: auth_ticket
        ApiKeyAuth auth_ticket = (ApiKeyAuth) defaultClient.getAuthentication("auth_ticket");
        auth_ticket.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //auth_ticket.setApiKeyPrefix("Token");

        TopologyApi apiInstance = new TopologyApi();
        try {
            TopologyResult result = apiInstance.getPhysicalTopology();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TopologyApi#getPhysicalTopology");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.TopologyApi;

public class TopologyApiExample {

    public static void main(String[] args) {
        TopologyApi apiInstance = new TopologyApi();
        try {
            TopologyResult result = apiInstance.getPhysicalTopology();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TopologyApi#getPhysicalTopology");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: auth_ticket)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Auth-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Auth-Token"];


TopologyApi *apiInstance = [[TopologyApi alloc] init];

// getPhysicalTopology
[apiInstance getPhysicalTopologyWithCompletionHandler: 
              ^(TopologyResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var CiscoPacketTracerNorthboundApiForNetworkControllerDevice = require('cisco_packet_tracer_northbound_api_for_network_controller_device');
var defaultClient = CiscoPacketTracerNorthboundApiForNetworkControllerDevice.ApiClient.instance;

// Configure API key authorization: auth_ticket
var auth_ticket = defaultClient.authentications['auth_ticket'];
auth_ticket.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//auth_ticket.apiKeyPrefix['X-Auth-Token'] = "Token"

var api = new CiscoPacketTracerNorthboundApiForNetworkControllerDevice.TopologyApi()

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPhysicalTopology(callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getPhysicalTopologyExample
    {
        public void main()
        {
            
            // Configure API key authorization: auth_ticket
            Configuration.Default.ApiKey.Add("X-Auth-Token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Auth-Token", "Bearer");

            var apiInstance = new TopologyApi();

            try
            {
                // getPhysicalTopology
                TopologyResult result = apiInstance.getPhysicalTopology();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TopologyApi.getPhysicalTopology: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: auth_ticket
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');

$api_instance = new Swagger\Client\Api\TopologyApi();

try {
    $result = $api_instance->getPhysicalTopology();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TopologyApi->getPhysicalTopology: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TopologyApi;

# Configure API key authorization: auth_ticket
$WWW::SwaggerClient::Configuration::api_key->{'X-Auth-Token'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Auth-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::TopologyApi->new();

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

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: auth_ticket
swagger_client.configuration.api_key['X-Auth-Token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Auth-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.TopologyApi()


try: 
    # getPhysicalTopology
    api_response = api_instance.get_physical_topology()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TopologyApi->getPhysicalTopology: %s\n" % e)

Parameters

Responses

Status: 200 - success

Schema

Status: 401 - Not Authorized Yet, Credentials to be supplied

Status: 500 - The server could not fulfill the request.

Status: 501 - The server has not implemented the functionality required to fulfill the request.

Users API

addSetup

This method is used to add setup information. This API is only available for the virtual Packet Tracer environment.

/user/setup

Usage and SDK Samples

Curl

curl -X POST "http://{IP}:{PORT}/api/v1/user/setup"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UserApi;

import java.io.File;
import java.util.*;

public class UserApiExample {

    public static void main(String[] args) {
        
        UserApi apiInstance = new UserApi();
        User_UserReqSetup user = ; // User_UserReqSetup | administrative user
        try {
            Common_BooleanResponse result = apiInstance.addSetup(user);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#addSetup");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.UserApi;

public class UserApiExample {

    public static void main(String[] args) {
        UserApi apiInstance = new UserApi();
        User_UserReqSetup user = ; // User_UserReqSetup | administrative user
        try {
            Common_BooleanResponse result = apiInstance.addSetup(user);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#addSetup");
            e.printStackTrace();
        }
    }
}

User_UserReqSetup *user = ; // administrative user (optional)

UserApi *apiInstance = [[UserApi alloc] init];

// addSetup
[apiInstance addSetupWith:user
              completionHandler: ^(Common_BooleanResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var CiscoPacketTracerNorthboundApiForNetworkControllerDevice = require('cisco_packet_tracer_northbound_api_for_network_controller_device');

var api = new CiscoPacketTracerNorthboundApiForNetworkControllerDevice.UserApi()

var opts = { 
  'user':  // {User_UserReqSetup} administrative user
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.addSetup(opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class addSetupExample
    {
        public void main()
        {
            
            var apiInstance = new UserApi();
            var user = new User_UserReqSetup(); // User_UserReqSetup | administrative user (optional) 

            try
            {
                // addSetup
                Common_BooleanResponse result = apiInstance.addSetup(user);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UserApi.addSetup: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\UserApi();
$user = ; // User_UserReqSetup | administrative user

try {
    $result = $api_instance->addSetup($user);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserApi->addSetup: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::UserApi;

my $api_instance = WWW::SwaggerClient::UserApi->new();
my $user = WWW::SwaggerClient::Object::User_UserReqSetup->new(); # User_UserReqSetup | administrative user

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

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.UserApi()
user =  # User_UserReqSetup | administrative user (optional)


try: 
    # addSetup
    api_response = api_instance.add_setup(user=user)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserApi->addSetup: %s\n" % e)

Parameters

Body parameters

Name	Description
user

Responses

Status: 200 - success

Schema

Status: 201 - The POST request was fulfilled and a new resource has been created. Information about the resource is in the response body.

Status: 400 - The client made a request that the server could not understand (for example, the request syntax is incorrect).

Status: 401 - Not Authorized Yet, Credentials to be supplied

Status: 500 - The server could not fulfill the request.

Status: 501 - The server has not implemented the functionality required to fulfill the request.

addUser

This method is used to add a new user. The password is excluded from the json schema below, but will still need to be included.

/user

Usage and SDK Samples

Curl

curl -X POST -H "X-Auth-Token: [[apiKey]]" "http://{IP}:{PORT}/api/v1/user"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UserApi;

import java.io.File;
import java.util.*;

public class UserApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: auth_ticket
        ApiKeyAuth auth_ticket = (ApiKeyAuth) defaultClient.getAuthentication("auth_ticket");
        auth_ticket.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //auth_ticket.setApiKeyPrefix("Token");

        UserApi apiInstance = new UserApi();
        User_UserReqRes user = ; // User_UserReqRes | user
        try {
            Common_BooleanResponse result = apiInstance.addUser(user);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#addUser");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.UserApi;

public class UserApiExample {

    public static void main(String[] args) {
        UserApi apiInstance = new UserApi();
        User_UserReqRes user = ; // User_UserReqRes | user
        try {
            Common_BooleanResponse result = apiInstance.addUser(user);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#addUser");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: auth_ticket)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Auth-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Auth-Token"];

User_UserReqRes *user = ; // user (optional)

UserApi *apiInstance = [[UserApi alloc] init];

// addUser
[apiInstance addUserWith:user
              completionHandler: ^(Common_BooleanResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var CiscoPacketTracerNorthboundApiForNetworkControllerDevice = require('cisco_packet_tracer_northbound_api_for_network_controller_device');
var defaultClient = CiscoPacketTracerNorthboundApiForNetworkControllerDevice.ApiClient.instance;

// Configure API key authorization: auth_ticket
var auth_ticket = defaultClient.authentications['auth_ticket'];
auth_ticket.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//auth_ticket.apiKeyPrefix['X-Auth-Token'] = "Token"

var api = new CiscoPacketTracerNorthboundApiForNetworkControllerDevice.UserApi()

var opts = { 
  'user':  // {User_UserReqRes} user
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.addUser(opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class addUserExample
    {
        public void main()
        {
            
            // Configure API key authorization: auth_ticket
            Configuration.Default.ApiKey.Add("X-Auth-Token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Auth-Token", "Bearer");

            var apiInstance = new UserApi();
            var user = new User_UserReqRes(); // User_UserReqRes | user (optional) 

            try
            {
                // addUser
                Common_BooleanResponse result = apiInstance.addUser(user);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UserApi.addUser: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: auth_ticket
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');

$api_instance = new Swagger\Client\Api\UserApi();
$user = ; // User_UserReqRes | user

try {
    $result = $api_instance->addUser($user);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserApi->addUser: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::UserApi;

# Configure API key authorization: auth_ticket
$WWW::SwaggerClient::Configuration::api_key->{'X-Auth-Token'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Auth-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::UserApi->new();
my $user = WWW::SwaggerClient::Object::User_UserReqRes->new(); # User_UserReqRes | user

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

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: auth_ticket
swagger_client.configuration.api_key['X-Auth-Token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Auth-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.UserApi()
user =  # User_UserReqRes | user (optional)


try: 
    # addUser
    api_response = api_instance.add_user(user=user)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserApi->addUser: %s\n" % e)

Parameters

Body parameters

Name	Description
user

Responses

Status: 200 - success

Schema

Status: 201 - The POST request was fulfilled and a new resource has been created. Information about the resource is in the response body.

Status: 400 - The client made a request that the server could not understand (for example, the request syntax is incorrect).

Status: 401 - Not Authorized Yet, Credentials to be supplied

Status: 500 - The server could not fulfill the request.

Status: 501 - The server has not implemented the functionality required to fulfill the request.

deleteUser

This method is used to delete a user. Admin permission is required. It is possible to delete your own user.

/user/{username}

Usage and SDK Samples

Curl

curl -X DELETE -H "X-Auth-Token: [[apiKey]]" "http://{IP}:{PORT}/api/v1/user/{username}"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UserApi;

import java.io.File;
import java.util.*;

public class UserApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: auth_ticket
        ApiKeyAuth auth_ticket = (ApiKeyAuth) defaultClient.getAuthentication("auth_ticket");
        auth_ticket.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //auth_ticket.setApiKeyPrefix("Token");

        UserApi apiInstance = new UserApi();
        String username = username_example; // String | username
        try {
            Common_BooleanResponse result = apiInstance.deleteUser(username);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#deleteUser");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.UserApi;

public class UserApiExample {

    public static void main(String[] args) {
        UserApi apiInstance = new UserApi();
        String username = username_example; // String | username
        try {
            Common_BooleanResponse result = apiInstance.deleteUser(username);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#deleteUser");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: auth_ticket)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Auth-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Auth-Token"];

String *username = username_example; // username

UserApi *apiInstance = [[UserApi alloc] init];

// deleteUser
[apiInstance deleteUserWith:username
              completionHandler: ^(Common_BooleanResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var CiscoPacketTracerNorthboundApiForNetworkControllerDevice = require('cisco_packet_tracer_northbound_api_for_network_controller_device');
var defaultClient = CiscoPacketTracerNorthboundApiForNetworkControllerDevice.ApiClient.instance;

// Configure API key authorization: auth_ticket
var auth_ticket = defaultClient.authentications['auth_ticket'];
auth_ticket.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//auth_ticket.apiKeyPrefix['X-Auth-Token'] = "Token"

var api = new CiscoPacketTracerNorthboundApiForNetworkControllerDevice.UserApi()

var username = username_example; // {String} username


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteUser(username, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteUserExample
    {
        public void main()
        {
            
            // Configure API key authorization: auth_ticket
            Configuration.Default.ApiKey.Add("X-Auth-Token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Auth-Token", "Bearer");

            var apiInstance = new UserApi();
            var username = username_example;  // String | username

            try
            {
                // deleteUser
                Common_BooleanResponse result = apiInstance.deleteUser(username);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UserApi.deleteUser: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: auth_ticket
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');

$api_instance = new Swagger\Client\Api\UserApi();
$username = username_example; // String | username

try {
    $result = $api_instance->deleteUser($username);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserApi->deleteUser: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::UserApi;

# Configure API key authorization: auth_ticket
$WWW::SwaggerClient::Configuration::api_key->{'X-Auth-Token'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Auth-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::UserApi->new();
my $username = username_example; # String | username

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

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: auth_ticket
swagger_client.configuration.api_key['X-Auth-Token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Auth-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.UserApi()
username = username_example # String | username


try: 
    # deleteUser
    api_response = api_instance.delete_user(username)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserApi->deleteUser: %s\n" % e)

Parameters

Path parameters

Name	Description
username*	String username Required

Responses

Status: 200 - success

Schema

Status: 400 - The client made a request that the server could not understand (for example, the request syntax is incorrect).

Status: 401 - Not Authorized Yet, Credentials to be supplied

Status: 403 - This user is Forbidden Access to this Resource

Status: 404 - No Resource Found

Status: 500 - The server could not fulfill the request.

Status: 501 - The server has not implemented the functionality required to fulfill the request.

getSetup

This method is used to get the setup status.

/user/setup

Usage and SDK Samples

Curl

curl -X GET "http://{IP}:{PORT}/api/v1/user/setup"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UserApi;

import java.io.File;
import java.util.*;

public class UserApiExample {

    public static void main(String[] args) {
        
        UserApi apiInstance = new UserApi();
        try {
            Common_BooleanResponse result = apiInstance.getSetup();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#getSetup");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.UserApi;

public class UserApiExample {

    public static void main(String[] args) {
        UserApi apiInstance = new UserApi();
        try {
            Common_BooleanResponse result = apiInstance.getSetup();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#getSetup");
            e.printStackTrace();
        }
    }
}


UserApi *apiInstance = [[UserApi alloc] init];

// getSetup
[apiInstance getSetupWithCompletionHandler: 
              ^(Common_BooleanResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var CiscoPacketTracerNorthboundApiForNetworkControllerDevice = require('cisco_packet_tracer_northbound_api_for_network_controller_device');

var api = new CiscoPacketTracerNorthboundApiForNetworkControllerDevice.UserApi()

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getSetup(callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getSetupExample
    {
        public void main()
        {
            
            var apiInstance = new UserApi();

            try
            {
                // getSetup
                Common_BooleanResponse result = apiInstance.getSetup();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UserApi.getSetup: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\UserApi();

try {
    $result = $api_instance->getSetup();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserApi->getSetup: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::UserApi;

my $api_instance = WWW::SwaggerClient::UserApi->new();

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

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.UserApi()


try: 
    # getSetup
    api_response = api_instance.get_setup()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserApi->getSetup: %s\n" % e)

Parameters

Responses

Status: 200 - success

Schema

Status: 401 - Not Authorized Yet, Credentials to be supplied

Status: 500 - The server could not fulfill the request.

Status: 501 - The server has not implemented the functionality required to fulfill the request.

getUser

This method is used to get user data by username.

/user/{username}

Usage and SDK Samples

Curl

curl -X GET -H "X-Auth-Token: [[apiKey]]" "http://{IP}:{PORT}/api/v1/user/{username}"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UserApi;

import java.io.File;
import java.util.*;

public class UserApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: auth_ticket
        ApiKeyAuth auth_ticket = (ApiKeyAuth) defaultClient.getAuthentication("auth_ticket");
        auth_ticket.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //auth_ticket.setApiKeyPrefix("Token");

        UserApi apiInstance = new UserApi();
        String username = username_example; // String | username
        try {
            User_UserResult result = apiInstance.getUser(username);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#getUser");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.UserApi;

public class UserApiExample {

    public static void main(String[] args) {
        UserApi apiInstance = new UserApi();
        String username = username_example; // String | username
        try {
            User_UserResult result = apiInstance.getUser(username);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#getUser");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: auth_ticket)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Auth-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Auth-Token"];

String *username = username_example; // username

UserApi *apiInstance = [[UserApi alloc] init];

// getUser
[apiInstance getUserWith:username
              completionHandler: ^(User_UserResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var CiscoPacketTracerNorthboundApiForNetworkControllerDevice = require('cisco_packet_tracer_northbound_api_for_network_controller_device');
var defaultClient = CiscoPacketTracerNorthboundApiForNetworkControllerDevice.ApiClient.instance;

// Configure API key authorization: auth_ticket
var auth_ticket = defaultClient.authentications['auth_ticket'];
auth_ticket.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//auth_ticket.apiKeyPrefix['X-Auth-Token'] = "Token"

var api = new CiscoPacketTracerNorthboundApiForNetworkControllerDevice.UserApi()

var username = username_example; // {String} username


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getUser(username, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getUserExample
    {
        public void main()
        {
            
            // Configure API key authorization: auth_ticket
            Configuration.Default.ApiKey.Add("X-Auth-Token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Auth-Token", "Bearer");

            var apiInstance = new UserApi();
            var username = username_example;  // String | username

            try
            {
                // getUser
                User_UserResult result = apiInstance.getUser(username);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UserApi.getUser: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: auth_ticket
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');

$api_instance = new Swagger\Client\Api\UserApi();
$username = username_example; // String | username

try {
    $result = $api_instance->getUser($username);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserApi->getUser: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::UserApi;

# Configure API key authorization: auth_ticket
$WWW::SwaggerClient::Configuration::api_key->{'X-Auth-Token'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Auth-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::UserApi->new();
my $username = username_example; # String | username

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

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: auth_ticket
swagger_client.configuration.api_key['X-Auth-Token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Auth-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.UserApi()
username = username_example # String | username


try: 
    # getUser
    api_response = api_instance.get_user(username)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserApi->getUser: %s\n" % e)

Parameters

Path parameters

Name	Description
username*	String username Required

Responses

Status: 200 - success

Schema

Status: 400 - The client made a request that the server could not understand (for example, the request syntax is incorrect).

Status: 401 - Not Authorized Yet, Credentials to be supplied

Status: 403 - This user is Forbidden Access to this Resource

Status: 404 - No Resource Found

Status: 500 - The server could not fulfill the request.

Status: 501 - The server has not implemented the functionality required to fulfill the request.

getUsers

This method is used to get the list of Users. If you are an admin user, this will return a list of all the users, if you have an observer role, it will only show your own user information.

/user

Usage and SDK Samples

Curl

curl -X GET -H "X-Auth-Token: [[apiKey]]" "http://{IP}:{PORT}/api/v1/user"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UserApi;

import java.io.File;
import java.util.*;

public class UserApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: auth_ticket
        ApiKeyAuth auth_ticket = (ApiKeyAuth) defaultClient.getAuthentication("auth_ticket");
        auth_ticket.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //auth_ticket.setApiKeyPrefix("Token");

        UserApi apiInstance = new UserApi();
        try {
            User_UserListResult result = apiInstance.getUsers();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#getUsers");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.UserApi;

public class UserApiExample {

    public static void main(String[] args) {
        UserApi apiInstance = new UserApi();
        try {
            User_UserListResult result = apiInstance.getUsers();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#getUsers");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: auth_ticket)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Auth-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Auth-Token"];


UserApi *apiInstance = [[UserApi alloc] init];

// getUsers
[apiInstance getUsersWithCompletionHandler: 
              ^(User_UserListResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var CiscoPacketTracerNorthboundApiForNetworkControllerDevice = require('cisco_packet_tracer_northbound_api_for_network_controller_device');
var defaultClient = CiscoPacketTracerNorthboundApiForNetworkControllerDevice.ApiClient.instance;

// Configure API key authorization: auth_ticket
var auth_ticket = defaultClient.authentications['auth_ticket'];
auth_ticket.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//auth_ticket.apiKeyPrefix['X-Auth-Token'] = "Token"

var api = new CiscoPacketTracerNorthboundApiForNetworkControllerDevice.UserApi()

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getUsers(callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getUsersExample
    {
        public void main()
        {
            
            // Configure API key authorization: auth_ticket
            Configuration.Default.ApiKey.Add("X-Auth-Token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Auth-Token", "Bearer");

            var apiInstance = new UserApi();

            try
            {
                // getUsers
                User_UserListResult result = apiInstance.getUsers();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UserApi.getUsers: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: auth_ticket
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');

$api_instance = new Swagger\Client\Api\UserApi();

try {
    $result = $api_instance->getUsers();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserApi->getUsers: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::UserApi;

# Configure API key authorization: auth_ticket
$WWW::SwaggerClient::Configuration::api_key->{'X-Auth-Token'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Auth-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::UserApi->new();

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

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: auth_ticket
swagger_client.configuration.api_key['X-Auth-Token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Auth-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.UserApi()


try: 
    # getUsers
    api_response = api_instance.get_users()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserApi->getUsers: %s\n" % e)

Parameters

Responses

Status: 200 - success

Schema

Status: 400 - The client made a request that the server could not understand (for example, the request syntax is incorrect).

Status: 401 - Not Authorized Yet, Credentials to be supplied

Status: 403 - This user is Forbidden Access to this Resource

Status: 500 - The server could not fulfill the request.

Status: 501 - The server has not implemented the functionality required to fulfill the request.

updateUser

This method is used to update user data. To update the password, "oldPassword" will need to be provided and the new password can be represented as "password". A user can only update their own password. For an admin to update another admin or user's password, then the process is to delete and add a new user by the same name with the same permissions.

/user

Usage and SDK Samples

Curl

curl -X PUT -H "X-Auth-Token: [[apiKey]]" "http://{IP}:{PORT}/api/v1/user"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UserApi;

import java.io.File;
import java.util.*;

public class UserApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: auth_ticket
        ApiKeyAuth auth_ticket = (ApiKeyAuth) defaultClient.getAuthentication("auth_ticket");
        auth_ticket.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //auth_ticket.setApiKeyPrefix("Token");

        UserApi apiInstance = new UserApi();
        User_UserReqRes user = ; // User_UserReqRes | user
        try {
            Common_BooleanResponse result = apiInstance.updateUser(user);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#updateUser");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.UserApi;

public class UserApiExample {

    public static void main(String[] args) {
        UserApi apiInstance = new UserApi();
        User_UserReqRes user = ; // User_UserReqRes | user
        try {
            Common_BooleanResponse result = apiInstance.updateUser(user);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#updateUser");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: auth_ticket)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Auth-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Auth-Token"];

User_UserReqRes *user = ; // user (optional)

UserApi *apiInstance = [[UserApi alloc] init];

// updateUser
[apiInstance updateUserWith:user
              completionHandler: ^(Common_BooleanResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var CiscoPacketTracerNorthboundApiForNetworkControllerDevice = require('cisco_packet_tracer_northbound_api_for_network_controller_device');
var defaultClient = CiscoPacketTracerNorthboundApiForNetworkControllerDevice.ApiClient.instance;

// Configure API key authorization: auth_ticket
var auth_ticket = defaultClient.authentications['auth_ticket'];
auth_ticket.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//auth_ticket.apiKeyPrefix['X-Auth-Token'] = "Token"

var api = new CiscoPacketTracerNorthboundApiForNetworkControllerDevice.UserApi()

var opts = { 
  'user':  // {User_UserReqRes} user
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateUser(opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateUserExample
    {
        public void main()
        {
            
            // Configure API key authorization: auth_ticket
            Configuration.Default.ApiKey.Add("X-Auth-Token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Auth-Token", "Bearer");

            var apiInstance = new UserApi();
            var user = new User_UserReqRes(); // User_UserReqRes | user (optional) 

            try
            {
                // updateUser
                Common_BooleanResponse result = apiInstance.updateUser(user);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UserApi.updateUser: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: auth_ticket
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');

$api_instance = new Swagger\Client\Api\UserApi();
$user = ; // User_UserReqRes | user

try {
    $result = $api_instance->updateUser($user);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserApi->updateUser: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::UserApi;

# Configure API key authorization: auth_ticket
$WWW::SwaggerClient::Configuration::api_key->{'X-Auth-Token'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Auth-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::UserApi->new();
my $user = WWW::SwaggerClient::Object::User_UserReqRes->new(); # User_UserReqRes | user

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

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: auth_ticket
swagger_client.configuration.api_key['X-Auth-Token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Auth-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.UserApi()
user =  # User_UserReqRes | user (optional)


try: 
    # updateUser
    api_response = api_instance.update_user(user=user)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserApi->updateUser: %s\n" % e)

Parameters

Body parameters

Name	Description
user

Responses

Status: 200 - success

Schema

Status: 400 - The client made a request that the server could not understand (for example, the request syntax is incorrect).

Status: 401 - Not Authorized Yet, Credentials to be supplied

Status: 500 - The server could not fulfill the request.

Status: 501 - The server has not implemented the functionality required to fulfill the request.

User Roles API

getRoles

This method is used to get the list of roles

/user/role

Usage and SDK Samples

Curl

curl -X GET "http://{IP}:{PORT}/api/v1/user/role"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UserroleApi;

import java.io.File;
import java.util.*;

public class UserroleApiExample {

    public static void main(String[] args) {
        
        UserroleApi apiInstance = new UserroleApi();
        try {
            User_RoleListResult result = apiInstance.getRoles();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserroleApi#getRoles");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.UserroleApi;

public class UserroleApiExample {

    public static void main(String[] args) {
        UserroleApi apiInstance = new UserroleApi();
        try {
            User_RoleListResult result = apiInstance.getRoles();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserroleApi#getRoles");
            e.printStackTrace();
        }
    }
}


UserroleApi *apiInstance = [[UserroleApi alloc] init];

// getRoles
[apiInstance getRolesWithCompletionHandler: 
              ^(User_RoleListResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var CiscoPacketTracerNorthboundApiForNetworkControllerDevice = require('cisco_packet_tracer_northbound_api_for_network_controller_device');

var api = new CiscoPacketTracerNorthboundApiForNetworkControllerDevice.UserroleApi()

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getRoles(callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getRolesExample
    {
        public void main()
        {
            
            var apiInstance = new UserroleApi();

            try
            {
                // getRoles
                User_RoleListResult result = apiInstance.getRoles();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UserroleApi.getRoles: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\UserroleApi();

try {
    $result = $api_instance->getRoles();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserroleApi->getRoles: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::UserroleApi;

my $api_instance = WWW::SwaggerClient::UserroleApi->new();

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

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.UserroleApi()


try: 
    # getRoles
    api_response = api_instance.get_roles()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserroleApi->getRoles: %s\n" % e)

Parameters

Responses

Status: 200 - success

Schema

Cisco Packet Tracer Northbound API for Network Controller Device

API and SDK Documentation

Tickets API

addTicket

Usage and SDK Samples

Parameters

Responses

Status: 200 - success

Status: 201 - The POST request was fulfilled and a new resource has been created. Information about the resource is in the response body.

Status: 400 - The client made a request that the server could not understand (for example, the request syntax is incorrect).

Status: 401 - Not Authorized Yet, Credentials to be supplied

Status: 500 - The server could not fulfill the request.

Status: 501 - The server has not implemented the functionality required to fulfill the request.

deleteTicket

Usage and SDK Samples

Parameters

Responses

Status: 200 - success

Status: 400 - The client made a request that the server could not understand (for example, the request syntax is incorrect).

Status: 401 - Not Authorized Yet, Credentials to be supplied

Status: 404 - No Resource Found

Status: 500 - The server could not fulfill the request.

Status: 501 - The server has not implemented the functionality required to fulfill the request.

Inventory API

addNetworkDevice

Usage and SDK Samples

Parameters

Responses

Status: 200 - The request was successful. The result is contained in the response body.

Status: 201 - The POST request was fulfilled and a new resource has been created. Information about the resource is in the response body.

Status: 400 - The client made a request that the server could not understand (for example, the request syntax is incorrect).

Status: 401 - Not Authorized Yet, Credentials to be supplied

Status: 500 - The server could not fulfill the request.

Status: 501 - The server has not implemented the functionality required to fulfill the request.

deleteNetworkDeviceById

Usage and SDK Samples

Parameters

Responses

Status: 200 - The request was successful.

Status: 401 - Not Authorized Yet, Credentials to be supplied

Status: 404 - No Resource Found

Status: 500 - The server could not fulfill the request.

Status: 501 - The server has not implemented the functionality required to fulfill the request.

deleteNetworkDeviceByIp

Usage and SDK Samples

Parameters

Responses

Status: 200 - The request was successful.

Status: 401 - Not Authorized Yet, Credentials to be supplied

Status: 404 - No Resource Found

Status: 500 - The server could not fulfill the request.

Status: 501 - The server has not implemented the functionality required to fulfill the request.

getNetworkDeviceById

Usage and SDK Samples

Parameters

Responses

Status: 200 - The request was successful. The result is contained in the response body.

Status: 401 - Not Authorized Yet, Credentials to be supplied

Status: 404 - No Resource Found

Status: 500 - The server could not fulfill the request.

Status: 501 - The server has not implemented the functionality required to fulfill the request.

getNetworkDeviceByIp

Usage and SDK Samples

Parameters

Responses

Status: 200 - The request was successful. The result is contained in the response body.

Status: 401 - Not Authorized Yet, Credentials to be supplied

Status: 404 - No Resource Found

Status: 500 - The server could not fulfill the request.

Status: 501 - The server has not implemented the functionality required to fulfill the request.

getNetworkDeviceCount

Usage and SDK Samples

Parameters

Responses

Status: 200 - The request was successful. The result is contained in the response body.

Status: 401 - Not Authorized Yet, Credentials to be supplied

Status: 500 - The server could not fulfill the request.

Status: 501 - The server has not implemented the functionality required to fulfill the request.

getNetworkDeviceRange

Usage and SDK Samples