Cisco Network Services Manager User Guide, 5.0
Northbound API Parameters
Downloads: This chapterpdf (PDF - 78.0KB) The complete bookPDF (PDF - 1.31MB) | Feedback

Northbound API Parameters

Table Of Contents

Northbound API Parameters


Northbound API Parameters


Table A-1 identifies parameters that can be issued via the NB API, along with the XML value types. Each value is wrapped in an element that identifies its type, as shown in the table.

Table A-1 NB API Parameters and XML Types 

Value Type
XML Example
XML Value Type

Boolean

<value>
  <name>param1</name>
  <boolean>true</boolean>
</value>
 
        

boolean

date

<value>
  <name>param1</name>
  <date>2011-03-04T12:34:45-08:00</date>
</value>
 
        

date

integer

<value>
  <name>param1</name>
  <integer>123</integer>
</value>
 
        

integer

ipv4

<value>
  <name>param1</name>
  <ipv4>10.1.2.3</ipv4>
</value>
 
        

IPv4Value

ipv4Addresses

<value>
  <name>param1</name>
  <ipv4Addresses>
    <ipv4>10.1.2.3</ipv4>
    <ipv4>10.1.2.4</ipv4>
  </ipv4Addresses>
</value>
 
        

IPv4ListValue

ipv4Pair

<value>
  <name>param1</name>
  <ipv4Pair>
    <ipv4Type>
      <name>public</name>
      <ipv4>0.0.0.0</ipv4>
    </ipv4Type>
    <ipv4Type>
      <name>private</name>
      <ipv4>1.1.1.1</ipv4>
    </ipv4Type>           
  </ipv4Pair>
</value>
 
        

IPv4PairValue

ipv4Pairs

<value>
  <name>param1</name>
  <ipv4Pairs>
    <ipv4Pair>
      <ipv4Type>
        <name>public</name>
        <ipv4>0.0.0.0</ipv4>
      </ipv4Type>
      <ipv4Type>
        <name>private</name>
        <ipv4>1.1.1.1</ipv4>
      </ipv4Type>           
    </ipv4Pair>          
    <ipv4Pair>
      <ipv4Type>
        <name>three</name>
        <ipv4>10.0.0.3</ipv4>
      </ipv4Type>
      <ipv4Type>
        <name>four</name>
        <ipv4>10.0.0.4</ipv4>
      </ipv4Type>           
    </ipv4Pair>
  </ipv4Pairs>
</value>
 
        

IPv4PairListValue

ipv4Type

<value>
  <name>param1</name>
  <ipv4Type>
    <name>public</name>
    <ipv4>0.0.0.0</ipv4>
  </ipv4Type>
</value>
 
        

IPv4TypeValue

macAddress

<value>
  <name>param1</name>
 <macAddress>01:23:45:67:89:1a</macAddress>
</value>
 
        

MACAddressValue

qosPolicies

<value>
  <name>param1</name>
  <qosPolicies>
    <qosPolicy>
      <inPolicy>InPolicyName</inPolicy>
      <outPolicy>OutPolicyName</outPolicy>
    </qosPolicy>
  </qosPolicies>
</value>
 
        

QosPolicyListValue

qosPolicy

<value>
  <name>param1</name>
  <qosPolicy>
    <inPolicy>InPolicyName</inPolicy>
    <outPolicy>OutPolicyName</outPolicy>
  </qosPolicy>
</value>
 
        

QosPolicyValue

range

<value>
  <name>param1</name>
  <range>
    <start>123</start>
    <end>345</end>
  </range>
</value>
 
        

RangeValue

ranges

<value>
  <name>param1</name>
  <ranges>
    <range>
      <start>123</start>
      <end>135</end>
    </range>
    <range>
      <start>324</start>
      <end>345</end>
    </range>
  </ranges>
</value>
 
        

RangeListValue

scheduledDate

<value>
  <name>param1</name>
  <scheduledDate>
    <!-- choices are IMMEDIATE or NEVER -->
    <schedule>NEVER</schedule> 
  </scheduledDate>
</value>
 
        

ScheduledDateValue

string

<value>
  <name>param1</name>
  <string>abc 123</string>
</value>
 
        

string

strings

<value>
  <name>param1</name>
  <strings>
    <string>abc 123</string>
    <string>def 678</string>
  </strings>
</value>
 
        

StringListValue

subnet

<value>
  <name>param1</name>
  <subnet>
    <ipv4>10.0.0.0</ipv4>
    <mask>8</mask>
  </subnet>
</value>
 
        

SubnetValue

subnets

<value>
  <name>param1</name>
  <subnets>
    <subnet>
      <ipv4>10.0.0.0</ipv4>
      <mask>8</mask>
    </subnet>
    <subnet>
      <ipv4>192.168.1.0</ipv4>
      <mask>24</mask>
    </subnet>
  </subnets>
</value>
 
        

SubnetListValue

uid

<value>
  <name>param1</name>
  <uid>tenant-001</uid>
</value>
 
        

uid

vlanAssignment

<value>
  <name>param1</name>
  <vlanAssignment>
     <subnet>
      <ipv4>192.168.1.0</ipv4>
      <mask>24</mask>
    </subnet>
    <vlan>123</vlan>
  </vlanAssignment>
</value>
 
        

VlanAssignmentValue

vmAddress

<value>
  <name>param1</name>
  <vmAddress>
    <MAC>12:34:56:78:90:AB</MAC>
    <ipv4>192.168.0.0</ipv4>
    <fqdn>testhost.cisco.com</fqdn>
   </vmAddress>
</value>
 
        

VMAddressValue