/api/space/device-management/modeled-device-management/connection-profiles/{id}

The following operations are supported on this resource:

  • GET - View Connection Profile
  • PUT - Update Connection Profile
  • PATCH - Update Connection Profile using PATCH Request
  • DELETE - Delete Connection Profile
GET /modeled-device-management/connection-profiles/{id}Version 1

View Connection Profile.

Sample Usage

GET /modeled-device-management/connection-profiles/{id}


  • Parameters:
    NameTypeURI TypeDescriptionRequired
    idIntegerPathID Y
  • Sample Output XML:
    <connection-profile
         href="/api/space/device-management/modeled-device-management/connection-profiles/{id}" uri="/api/space/device-management/modeled-device-management/connection-profiles/{id}">
         <id>Integer</id>
         <name>String</name>
         <description>String</description>
         <interface-type>ETHERNET</interface-type>
         <interface-name>String</interface-name>
         <ip-type>String</ip-type>
         <use-nat>Boolean</use-nat>
         <type>String</type>
         <dhcp-retransmission-attempt>Integer</dhcp-retransmission-attempt>
         <dhcp-retransmission-interval>Integer</dhcp-retransmission-interval>
         <dhcp-server-address>String</dhcp-server-address>
         <dhcp-update-server>Boolean</dhcp-update-server>
         <dhcp-lease-never-expires>Boolean</dhcp-lease-never-expires>
         <dhcp-lease-time>Integer</dhcp-lease-time>
         <dhcp-default-lease>Boolean</dhcp-default-lease>
         <auth-protocol-type>String</auth-protocol-type>
         <user-name>String</user-name>
         <password>String</password>
         <access-profile-user-name>String</access-profile-user-name>
         <access-profile-password>String</access-profile-password>
         <vpi>Integer</vpi>
         <vci>Integer</vci>
         <encapsulation-type>String</encapsulation-type>
         <concentrator-name>String</concentrator-name>
         <service-name>String</service-name>
         <time-interval>Integer</time-interval>
         <idle-period>Integer</idle-period>
    </connection-profile>

  • Sample Output JSON:
    {
       "connection-profile" : {
         "@href" :
         "/api/space/device-management/modeled-device-management/connection-profiles/{id}"
         ,
         "@uri" :
         "/api/space/device-management/modeled-device-management/connection-profiles/{id}"
         ,
         "id" : "Integer" ,
         "name" : "String" ,
         "description" : "String" ,
         "interface-type" : "ETHERNET" ,
         "interface-name" : "String" ,
         "ip-type" : "String" ,
         "use-nat" : "Boolean" ,
         "type" : "String" ,
         "dhcp-retransmission-attempt" : "Integer" ,
         "dhcp-retransmission-interval" : "Integer" ,
         "dhcp-server-address" : "String" ,
         "dhcp-update-server" : "Boolean" ,
         "dhcp-lease-never-expires" : "Boolean" ,
         "dhcp-lease-time" : "Integer" ,
         "dhcp-default-lease" : "Boolean" ,
         "auth-protocol-type" : "String" ,
         "user-name" : "String" ,
         "password" : "String" ,
         "access-profile-user-name" : "String" ,
         "access-profile-password" : "String" ,
         "vpi" : "Integer" ,
         "vci" : "Integer" ,
         "encapsulation-type" : "String" ,
         "concentrator-name" : "String" ,
         "service-name" : "String" ,
         "time-interval" : "Integer" ,
         "idle-period" : "Integer"
       }
    }

  • Access Control

    The following capabilities are required to access this API: ViewConnectionProfile

    PUT /modeled-device-management/connection-profiles/{id}Version 1

    Sample Usage

    PUT /modeled-device-management/connection-profiles/{id}


    • Parameters:
      NameTypeURI TypeDescriptionRequired
      idIntegerPathID Y
  • Sample Input XML:
    <connection-profile>
         <name>String</name>
         <description>String</description>
         <interface-type>ETHERNET</interface-type>
         <interface-name>String</interface-name>
         <ip-type>String</ip-type>
         <use-nat>Boolean</use-nat>
         <type>String</type>
         <dhcp-retransmission-attempt>Integer</dhcp-retransmission-attempt>
         <dhcp-retransmission-interval>Integer</dhcp-retransmission-interval>
         <dhcp-server-address>String</dhcp-server-address>
         <dhcp-update-server>Boolean</dhcp-update-server>
         <dhcp-lease-never-expires>Boolean</dhcp-lease-never-expires>
         <dhcp-lease-time>Integer</dhcp-lease-time>
         <dhcp-default-lease>Boolean</dhcp-default-lease>
         <auth-protocol-type>String</auth-protocol-type>
         <user-name>String</user-name>
         <password>String</password>
         <access-profile-user-name>String</access-profile-user-name>
         <access-profile-password>String</access-profile-password>
         <vpi>Integer</vpi>
         <vci>Integer</vci>
         <encapsulation-type>String</encapsulation-type>
         <concentrator-name>String</concentrator-name>
         <service-name>String</service-name>
         <time-interval>Integer</time-interval>
         <idle-period>Integer</idle-period>
    </connection-profile>

  • Sample Output XML:
    <connection-profile
         href="/api/space/device-management/modeled-device-management/connection-profiles/{id}" uri="/api/space/device-management/modeled-device-management/connection-profiles/{id}">
         <id>Integer</id>
         <name>String</name>
         <description>String</description>
         <interface-type>ETHERNET</interface-type>
         <interface-name>String</interface-name>
         <ip-type>String</ip-type>
         <use-nat>Boolean</use-nat>
         <type>String</type>
         <dhcp-retransmission-attempt>Integer</dhcp-retransmission-attempt>
         <dhcp-retransmission-interval>Integer</dhcp-retransmission-interval>
         <dhcp-server-address>String</dhcp-server-address>
         <dhcp-update-server>Boolean</dhcp-update-server>
         <dhcp-lease-never-expires>Boolean</dhcp-lease-never-expires>
         <dhcp-lease-time>Integer</dhcp-lease-time>
         <dhcp-default-lease>Boolean</dhcp-default-lease>
         <auth-protocol-type>String</auth-protocol-type>
         <user-name>String</user-name>
         <password>String</password>
         <access-profile-user-name>String</access-profile-user-name>
         <access-profile-password>String</access-profile-password>
         <vpi>Integer</vpi>
         <vci>Integer</vci>
         <encapsulation-type>String</encapsulation-type>
         <concentrator-name>String</concentrator-name>
         <service-name>String</service-name>
         <time-interval>Integer</time-interval>
         <idle-period>Integer</idle-period>
    </connection-profile>

  • Sample Input JSON:
    {
       "connection-profile" : {
         "name" : "String" ,
         "description" : "String" ,
         "interface-type" : "ETHERNET" ,
         "interface-name" : "String" ,
         "ip-type" : "String" ,
         "use-nat" : "Boolean" ,
         "type" : "String" ,
         "dhcp-retransmission-attempt" : "Integer" ,
         "dhcp-retransmission-interval" : "Integer" ,
         "dhcp-server-address" : "String" ,
         "dhcp-update-server" : "Boolean" ,
         "dhcp-lease-never-expires" : "Boolean" ,
         "dhcp-lease-time" : "Integer" ,
         "dhcp-default-lease" : "Boolean" ,
         "auth-protocol-type" : "String" ,
         "user-name" : "String" ,
         "password" : "String" ,
         "access-profile-user-name" : "String" ,
         "access-profile-password" : "String" ,
         "vpi" : "Integer" ,
         "vci" : "Integer" ,
         "encapsulation-type" : "String" ,
         "concentrator-name" : "String" ,
         "service-name" : "String" ,
         "time-interval" : "Integer" ,
         "idle-period" : "Integer"
       }
    }

  • Sample Output JSON:
    {
       "connection-profile" : {
         "@href" :
         "/api/space/device-management/modeled-device-management/connection-profiles/{id}"
         ,
         "@uri" :
         "/api/space/device-management/modeled-device-management/connection-profiles/{id}"
         ,
         "id" : "Integer" ,
         "name" : "String" ,
         "description" : "String" ,
         "interface-type" : "ETHERNET" ,
         "interface-name" : "String" ,
         "ip-type" : "String" ,
         "use-nat" : "Boolean" ,
         "type" : "String" ,
         "dhcp-retransmission-attempt" : "Integer" ,
         "dhcp-retransmission-interval" : "Integer" ,
         "dhcp-server-address" : "String" ,
         "dhcp-update-server" : "Boolean" ,
         "dhcp-lease-never-expires" : "Boolean" ,
         "dhcp-lease-time" : "Integer" ,
         "dhcp-default-lease" : "Boolean" ,
         "auth-protocol-type" : "String" ,
         "user-name" : "String" ,
         "password" : "String" ,
         "access-profile-user-name" : "String" ,
         "access-profile-password" : "String" ,
         "vpi" : "Integer" ,
         "vci" : "Integer" ,
         "encapsulation-type" : "String" ,
         "concentrator-name" : "String" ,
         "service-name" : "String" ,
         "time-interval" : "Integer" ,
         "idle-period" : "Integer"
       }
    }

  • Access Control

    The following capabilities are required to access this API: ModifyConnectionProfiles

    PATCH /modeled-device-management/connection-profiles/{id}Version 1

    Update Connection Profile using PATCH Request.

    Sample Usage

    PATCH /modeled-device-management/connection-profiles/{id}


    • Parameters:
      NameTypeURI TypeDescriptionRequired
      idIntegerPathID Y
  • Sample Patch XML:
    <?xml version="1.0" encoding="UTF-8" standalone="no"?>
    <diff>
       <!--What you see below are just samples of patch operations that may be performed on this DTO.-->
       <!--For more information about patch document format please look at http://http://www.rfc-editor.org/rfc/rfc5261.txt-->
       <replace sel="connection-profile/name">
           <name>String</name>
       </replace>
       <replace sel="connection-profile/description">
           <description>String</description>
       </replace>
       <replace sel="connection-profile/interface-type">
           <interface-type>ETHERNET</interface-type>
       </replace>
       <replace sel="connection-profile/interface-name">
           <interface-name>String</interface-name>
       </replace>
       <replace sel="connection-profile/ip-type">
           <ip-type>String</ip-type>
       </replace>
       <replace sel="connection-profile/use-nat">
           <use-nat>Boolean</use-nat>
       </replace>
       <replace sel="connection-profile/type">
           <type>String</type>
       </replace>
       <replace sel="connection-profile/dhcp-retransmission-attempt">
           <dhcp-retransmission-attempt>Integer</dhcp-retransmission-attempt>
       </replace>
       <replace sel="connection-profile/dhcp-retransmission-interval">
           <dhcp-retransmission-interval>Integer</dhcp-retransmission-interval>
       </replace>
       <replace sel="connection-profile/dhcp-server-address">
           <dhcp-server-address>String</dhcp-server-address>
       </replace>
       <replace sel="connection-profile/dhcp-update-server">
           <dhcp-update-server>Boolean</dhcp-update-server>
       </replace>
       <replace sel="connection-profile/dhcp-lease-never-expires">
           <dhcp-lease-never-expires>Boolean</dhcp-lease-never-expires>
       </replace>
       <replace sel="connection-profile/dhcp-lease-time">
           <dhcp-lease-time>Integer</dhcp-lease-time>
       </replace>
       <replace sel="connection-profile/dhcp-default-lease">
           <dhcp-default-lease>Boolean</dhcp-default-lease>
       </replace>
       <replace sel="connection-profile/auth-protocol-type">
           <auth-protocol-type>String</auth-protocol-type>
       </replace>
       <replace sel="connection-profile/user-name">
           <user-name>String</user-name>
       </replace>
       <replace sel="connection-profile/password">
           <password>String</password>
       </replace>
       <replace sel="connection-profile/access-profile-user-name">
           <access-profile-user-name>String</access-profile-user-name>
       </replace>
       <replace sel="connection-profile/access-profile-password">
           <access-profile-password>String</access-profile-password>
       </replace>
       <replace sel="connection-profile/vpi">
           <vpi>Integer</vpi>
       </replace>
       <replace sel="connection-profile/vci">
           <vci>Integer</vci>
       </replace>
       <replace sel="connection-profile/encapsulation-type">
           <encapsulation-type>String</encapsulation-type>
       </replace>
       <replace sel="connection-profile/concentrator-name">
           <concentrator-name>String</concentrator-name>
       </replace>
       <replace sel="connection-profile/service-name">
           <service-name>String</service-name>
       </replace>
       <replace sel="connection-profile/time-interval">
           <time-interval>Integer</time-interval>
       </replace>
       <replace sel="connection-profile/idle-period">
           <idle-period>Integer</idle-period>
       </replace>
    </diff>

  • Sample Output XML:
    <connection-profile
         href="/api/space/device-management/modeled-device-management/connection-profiles/{id}" uri="/api/space/device-management/modeled-device-management/connection-profiles/{id}">
         <id>Integer</id>
         <name>String</name>
         <description>String</description>
         <interface-type>ETHERNET</interface-type>
         <interface-name>String</interface-name>
         <ip-type>String</ip-type>
         <use-nat>Boolean</use-nat>
         <type>String</type>
         <dhcp-retransmission-attempt>Integer</dhcp-retransmission-attempt>
         <dhcp-retransmission-interval>Integer</dhcp-retransmission-interval>
         <dhcp-server-address>String</dhcp-server-address>
         <dhcp-update-server>Boolean</dhcp-update-server>
         <dhcp-lease-never-expires>Boolean</dhcp-lease-never-expires>
         <dhcp-lease-time>Integer</dhcp-lease-time>
         <dhcp-default-lease>Boolean</dhcp-default-lease>
         <auth-protocol-type>String</auth-protocol-type>
         <user-name>String</user-name>
         <password>String</password>
         <access-profile-user-name>String</access-profile-user-name>
         <access-profile-password>String</access-profile-password>
         <vpi>Integer</vpi>
         <vci>Integer</vci>
         <encapsulation-type>String</encapsulation-type>
         <concentrator-name>String</concentrator-name>
         <service-name>String</service-name>
         <time-interval>Integer</time-interval>
         <idle-period>Integer</idle-period>
    </connection-profile>

  • Sample Output JSON:
    {
       "connection-profile" : {
         "@href" :
         "/api/space/device-management/modeled-device-management/connection-profiles/{id}"
         ,
         "@uri" :
         "/api/space/device-management/modeled-device-management/connection-profiles/{id}"
         ,
         "id" : "Integer" ,
         "name" : "String" ,
         "description" : "String" ,
         "interface-type" : "ETHERNET" ,
         "interface-name" : "String" ,
         "ip-type" : "String" ,
         "use-nat" : "Boolean" ,
         "type" : "String" ,
         "dhcp-retransmission-attempt" : "Integer" ,
         "dhcp-retransmission-interval" : "Integer" ,
         "dhcp-server-address" : "String" ,
         "dhcp-update-server" : "Boolean" ,
         "dhcp-lease-never-expires" : "Boolean" ,
         "dhcp-lease-time" : "Integer" ,
         "dhcp-default-lease" : "Boolean" ,
         "auth-protocol-type" : "String" ,
         "user-name" : "String" ,
         "password" : "String" ,
         "access-profile-user-name" : "String" ,
         "access-profile-password" : "String" ,
         "vpi" : "Integer" ,
         "vci" : "Integer" ,
         "encapsulation-type" : "String" ,
         "concentrator-name" : "String" ,
         "service-name" : "String" ,
         "time-interval" : "Integer" ,
         "idle-period" : "Integer"
       }
    }

  • DELETE /modeled-device-management/connection-profiles/{id}Version 1

    Sample Usage

    DELETE /modeled-device-management/connection-profiles/{id}


    • Parameters:
      NameTypeURI TypeDescriptionRequired
      idIntegerPathID Y

    Access Control

    The following capabilities are required to access this API: DeleteConnectionProfiles