/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/2686976" uri="/api/space/device-management/modeled-device-management/connection-profiles/2686976">
         <id>2686976</id>
         <name>Connection_Profile</name>
         <description>test_description</description>
         <interface-type>ETHERNET</interface-type>
         <interface-name>test</interface-name>
         <ip-type>Ipv4</ip-type>
         <use-nat>false</use-nat>
         <type>Static</type>
         <dhcp-retransmission-attempt>1</dhcp-retransmission-attempt>
         <dhcp-retransmission-interval>2</dhcp-retransmission-interval>
         <dhcp-server-address>1.1.1.1</dhcp-server-address>
         <dhcp-update-server>false</dhcp-update-server>
         <dhcp-lease-never-expires>false</dhcp-lease-never-expires>
         <dhcp-lease-time>2</dhcp-lease-time>
         <dhcp-default-lease>false</dhcp-default-lease>
         <auth-protocol-type>PAP</auth-protocol-type>
         <user-name>root</user-name>
         <password>********</password>
         <access-profile-user-name>root</access-profile-user-name>
         <access-profile-password>********</access-profile-password>
         <vpi>2</vpi>
         <vci>2</vci>
         <encapsulation-type>atm-ppp-llc</encapsulation-type>
         <concentrator-name>test_concentrator</concentrator-name>
         <service-name>test_service</service-name>
         <time-interval>2</time-interval>
         <idle-period>2</idle-period>
    </connection-profile>

  • Sample Output JSON:
    {
       "connection-profile" : {
         "@href" : "/api/space/device-management/modeled-device-management/connection-profiles/2686976" ,
         "@uri" : "/api/space/device-management/modeled-device-management/connection-profiles/2686976" ,
         "id" : "2686976" ,
         "name" : "Connection_Profile" ,
         "description" : "test_description" ,
         "interface-type" : "ETHERNET" ,
         "interface-name" : "test" ,
         "ip-type" : "Ipv4" ,
         "use-nat" : "false" ,
         "type" : "Static" ,
         "dhcp-retransmission-attempt" : "1" ,
         "dhcp-retransmission-interval" : "2" ,
         "dhcp-server-address" : "1.1.1.1" ,
         "dhcp-update-server" : "false" ,
         "dhcp-lease-never-expires" : "false" ,
         "dhcp-lease-time" : "2" ,
         "dhcp-default-lease" : "false" ,
         "auth-protocol-type" : "PAP" ,
         "user-name" : "root" ,
         "password" : "********" ,
         "access-profile-user-name" : "root" ,
         "access-profile-password" : "********" ,
         "vpi" : "2" ,
         "vci" : "2" ,
         "encapsulation-type" : "atm-ppp-llc" ,
         "concentrator-name" : "test_concentrator" ,
         "service-name" : "test_service" ,
         "time-interval" : "2" ,
         "idle-period" : "2"
       }
    }

  • 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>Connection_Profile</name>
         <description>test_description</description>
         <interface-type>ETHERNET</interface-type>
         <interface-name>test</interface-name>
         <ip-type>Ipv4</ip-type>
         <use-nat>false</use-nat>
         <type>Static</type>
         <dhcp-retransmission-attempt>1</dhcp-retransmission-attempt>
         <dhcp-retransmission-interval>2</dhcp-retransmission-interval>
         <dhcp-server-address>1.1.1.1</dhcp-server-address>
         <dhcp-update-server>false</dhcp-update-server>
         <dhcp-lease-never-expires>false</dhcp-lease-never-expires>
         <dhcp-lease-time>2</dhcp-lease-time>
         <dhcp-default-lease>false</dhcp-default-lease>
         <auth-protocol-type>PAP</auth-protocol-type>
         <user-name>root</user-name>
         <password>********</password>
         <access-profile-user-name>root</access-profile-user-name>
         <access-profile-password>********</access-profile-password>
         <vpi>2</vpi>
         <vci>2</vci>
         <encapsulation-type>atm-ppp-llc</encapsulation-type>
         <concentrator-name>test_concentrator</concentrator-name>
         <service-name>test_service</service-name>
         <time-interval>2</time-interval>
         <idle-period>2</idle-period>
    </connection-profile>

  • Sample Output XML:
    <connection-profile>
         href="/api/space/device-management/modeled-device-management/connection-profiles/2686976" uri="/api/space/device-management/modeled-device-management/connection-profiles/2686976">
         <id>2686976</id>
         <name>Connection_Profile</name>
         <description>test_description</description>
         <interface-type>ETHERNET</interface-type>
         <interface-name>test</interface-name>
         <ip-type>Ipv4</ip-type>
         <use-nat>false</use-nat>
         <type>Static</type>
         <dhcp-retransmission-attempt>1</dhcp-retransmission-attempt>
         <dhcp-retransmission-interval>2</dhcp-retransmission-interval>
         <dhcp-server-address>1.1.1.1</dhcp-server-address>
         <dhcp-update-server>false</dhcp-update-server>
         <dhcp-lease-never-expires>false</dhcp-lease-never-expires>
         <dhcp-lease-time>2</dhcp-lease-time>
         <dhcp-default-lease>false</dhcp-default-lease>
         <auth-protocol-type>PAP</auth-protocol-type>
         <user-name>root</user-name>
         <password>********</password>
         <access-profile-user-name>root</access-profile-user-name>
         <access-profile-password>********</access-profile-password>
         <vpi>2</vpi>
         <vci>2</vci>
         <encapsulation-type>atm-ppp-llc</encapsulation-type>
         <concentrator-name>test_concentrator</concentrator-name>
         <service-name>test_service</service-name>
         <time-interval>2</time-interval>
         <idle-period>2</idle-period>
    </connection-profile>

  • Sample Input JSON:
    {
       "connection-profile" : {
         "name" : "Connection_Profile" ,
         "description" : "test_description" ,
         "interface-type" : "ETHERNET" ,
         "interface-name" : "test" ,
         "ip-type" : "Ipv4" ,
         "use-nat" : "false" ,
         "type" : "Static" ,
         "dhcp-retransmission-attempt" : "1" ,
         "dhcp-retransmission-interval" : "2" ,
         "dhcp-server-address" : "1.1.1.1" ,
         "dhcp-update-server" : "false" ,
         "dhcp-lease-never-expires" : "false" ,
         "dhcp-lease-time" : "2" ,
         "dhcp-default-lease" : "false" ,
         "auth-protocol-type" : "PAP" ,
         "user-name" : "root" ,
         "password" : "********" ,
         "access-profile-user-name" : "root" ,
         "access-profile-password" : "********" ,
         "vpi" : "2" ,
         "vci" : "2" ,
         "encapsulation-type" : "atm-ppp-llc" ,
         "concentrator-name" : "test_concentrator" ,
         "service-name" : "test_service" ,
         "time-interval" : "2" ,
         "idle-period" : "2"
       }
    }

  • Sample Output JSON:
    {
       "connection-profile" : {
         "@href" : "/api/space/device-management/modeled-device-management/connection-profiles/2686976" ,
         "@uri" : "/api/space/device-management/modeled-device-management/connection-profiles/2686976" ,
         "id" : "2686976" ,
         "name" : "Connection_Profile" ,
         "description" : "test_description" ,
         "interface-type" : "ETHERNET" ,
         "interface-name" : "test" ,
         "ip-type" : "Ipv4" ,
         "use-nat" : "false" ,
         "type" : "Static" ,
         "dhcp-retransmission-attempt" : "1" ,
         "dhcp-retransmission-interval" : "2" ,
         "dhcp-server-address" : "1.1.1.1" ,
         "dhcp-update-server" : "false" ,
         "dhcp-lease-never-expires" : "false" ,
         "dhcp-lease-time" : "2" ,
         "dhcp-default-lease" : "false" ,
         "auth-protocol-type" : "PAP" ,
         "user-name" : "root" ,
         "password" : "********" ,
         "access-profile-user-name" : "root" ,
         "access-profile-password" : "********" ,
         "vpi" : "2" ,
         "vci" : "2" ,
         "encapsulation-type" : "atm-ppp-llc" ,
         "concentrator-name" : "test_concentrator" ,
         "service-name" : "test_service" ,
         "time-interval" : "2" ,
         "idle-period" : "2"
       }
    }

  • 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/description">
           <description>Updated Connect Profile</description>
       </replace>
       <replace sel="connection-profile/interface-type">
           <interface-type>ETHERNET</interface-type>
       </replace>
       <replace sel="connection-profile/interface-name">
           <interface-name>me0</interface-name>
       </replace>
       <replace sel="connection-profile/ip-type">
           <ip-type>IPv4</ip-type>
       </replace>
       <replace sel="connection-profile/use-nat">
           <use-nat>false</use-nat>
       </replace>
       <replace sel="connection-profile/type">
           <type>DHCP</type>
       </replace>
       <replace sel="connection-profile/dhcp-retransmission-attempt">
           <dhcp-retransmission-attempt>1</dhcp-retransmission-attempt>
       </replace>
       <replace sel="connection-profile/dhcp-retransmission-interval">
           <dhcp-retransmission-interval>2</dhcp-retransmission-interval>
       </replace>
       <replace sel="connection-profile/dhcp-server-address">
           <dhcp-server-address>1.1.1.1</dhcp-server-address>
       </replace>
       <replace sel="connection-profile/dhcp-update-server">
           <dhcp-update-server>false</dhcp-update-server>
       </replace>
       <replace sel="connection-profile/dhcp-lease-never-expires">
           <dhcp-lease-never-expires>false</dhcp-lease-never-expires>
       </replace>
       <replace sel="connection-profile/dhcp-lease-time">
           <dhcp-lease-time>5</dhcp-lease-time>
       </replace>
       <replace sel="connection-profile/dhcp-default-lease">
           <dhcp-default-lease>false</dhcp-default-lease>
       </replace>
       <replace sel="connection-profile/auth-protocol-type">
           <auth-protocol-type>PAP</auth-protocol-type>
       </replace>
       <replace sel="connection-profile/user-name">
           <user-name>root</user-name>
       </replace>
       <replace sel="connection-profile/password">
           <password>********</password>
       </replace>
       <replace sel="connection-profile/access-profile-user-name">
           <access-profile-user-name>root</access-profile-user-name>
       </replace>
       <replace sel="connection-profile/access-profile-password">
           <access-profile-password>********</access-profile-password>
       </replace>
       <replace sel="connection-profile/vpi">
           <vpi>2</vpi>
       </replace>
       <replace sel="connection-profile/vci">
           <vci>2</vci>
       </replace>
       <replace sel="connection-profile/encapsulation-type">
           <encapsulation-type>atm-ppp-vc-mux</encapsulation-type>
       </replace>
       <replace sel="connection-profile/concentrator-name">
           <concentrator-name>concentrator-name</concentrator-name>
       </replace>
       <replace sel="connection-profile/service-name">
           <service-name>service-name</service-name>
       </replace>
       <replace sel="connection-profile/time-interval">
           <time-interval>2</time-interval>
       </replace>
       <replace sel="connection-profile/idle-period">
           <idle-period>1</idle-period>
       </replace>
    </diff>

  • Sample Output XML:
    <connection-profile
         href="/api/space/device-management/modeled-device-management/connection-profiles/2686977" uri="/api/space/device-management/modeled-device-management/connection-profiles/2686977">
         <id>2686977</id>
         <name>Connetion_Profile_DHCP</name>
         <description>Connetion_Profile_DHCP</description>
         <interface-type>ETHERNET</interface-type>
         <interface-name>me0</interface-name>
         <ip-type>IPv4</ip-type>
         <use-nat>false</use-nat>
         <type>DHCP</type>
         <dhcp-retransmission-attempt>1</dhcp-retransmission-attempt>
         <dhcp-retransmission-interval>2</dhcp-retransmission-interval>
         <dhcp-server-address>1.1.1.1</dhcp-server-address>
         <dhcp-update-server>false</dhcp-update-server>
         <dhcp-lease-never-expires>false</dhcp-lease-never-expires>
         <dhcp-lease-time>5</dhcp-lease-time>
         <dhcp-default-lease>false</dhcp-default-lease>
         <auth-protocol-type>PAP</auth-protocol-type>
         <user-name>root</user-name>
         <password>********</password>
         <access-profile-user-name>root</access-profile-user-name>
         <access-profile-password>********</access-profile-password>
         <vpi>2</vpi>
         <vci>2</vci>
         <encapsulation-type>atm-ppp-vc-mux</encapsulation-type>
         <concentrator-name>concentrator-name</concentrator-name>
         <service-name>service-name</service-name>
         <time-interval>2</time-interval>
         <idle-period>1</idle-period>
    </connection-profile>

  • Sample Output JSON:
    {
       "connection-profile" : {
         "@href" :
         "/api/space/device-management/modeled-device-management/connection-profiles/2686977" ,
         "@uri" :
         "/api/space/device-management/modeled-device-management/connection-profiles/2686977" ,
         "id" : "2686977" ,
         "name" : "Connetion_Profile_DHCP" ,
         "description" : "Updated Connect Profile" ,
         "interface-type" : "ETHERNET" ,
         "interface-name" : "me0" ,
         "ip-type" : "IPv" ,
         "use-nat" : "false" ,
         "type" : "DHCP" ,
         "dhcp-retransmission-attempt" : "1" ,
         "dhcp-retransmission-interval" : "2" ,
         "dhcp-server-address" : "1.1.1.1" ,
         "dhcp-update-server" : "false" ,
         "dhcp-lease-never-expires" : "false" ,
         "dhcp-lease-time" : "5" ,
         "dhcp-default-lease" : "false" ,
         "auth-protocol-type" : "PAP" ,
         "user-name" : "root" ,
         "password" : "********" ,
         "access-profile-user-name" : "root" ,
         "access-profile-password" : "********" ,
         "vpi" : "2" ,
         "vci" : "2" ,
         "encapsulation-type" : "atm-ppp-vc-mux" ,
         "concentrator-name" : "concentrator-name" ,
         "service-name" : "service-name" ,
         "time-interval" : "2" ,
         "idle-period" : "1"
       }
    }

  • Access Control

    The following capabilities are required to access this API: CreateConnectionProfiles, ModifyConnectionProfiles, DeleteConnectionProfiles

    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