[Index]
Model ref.: device/cucm/PhoneSecurityProfile
The full URL would include the host-proxy name: https://[host-proxy].
Variables are enclosed in square brackets.
{
"$schema": "http://json-schema.org/draft-03/schema",
"type": "object",
"properties": {
"phoneType": {
"title": "Phone Security Profile Type",
"minItems": 1,
"required": true,
"choices": [
{
"value": "Cisco 30 SP+",
"title": "Cisco 30 SP+"
},
{
"value": "Cisco 12 SP+",
"title": "Cisco 12 SP+"
},
{
"value": "Cisco 12 SP",
"title": "Cisco 12 SP"
},
{
"value": "Cisco 12 S",
"title": "Cisco 12 S"
},
{
"value": "Cisco 30 VIP",
"title": "Cisco 30 VIP"
},
{
"value": "Cisco 7910",
"title": "Cisco 7910"
},
{
"value": "Cisco 7960",
"title": "Cisco 7960"
},
{
"value": "Cisco 7940",
"title": "Cisco 7940"
},
{
"value": "Cisco 7935",
"title": "Cisco 7935"
},
{
"value": "Cisco VGC Phone",
"title": "Cisco VGC Phone"
},
{
"value": "Cisco VGC Virtual Phone",
"title": "Cisco VGC Virtual Phone"
},
{
"value": "Cisco ATA 186",
"title": "Cisco ATA 186"
},
{
"value": "EMCC Base Phone",
"title": "EMCC Base Phone"
},
{
"value": "SCCP Phone",
"title": "SCCP Phone"
},
{
"value": "Analog Access",
"title": "Analog Access"
},
{
"value": "Digital Access",
"title": "Digital Access"
},
{
"value": "Digital Access+",
"title": "Digital Access+"
},
{
"value": "Digital Access WS-X6608",
"title": "Digital Access WS-X6608"
},
{
"value": "Analog Access WS-X6624",
"title": "Analog Access WS-X6624"
},
{
"value": "VGC Gateway",
"title": "VGC Gateway"
},
{
"value": "Conference Bridge",
"title": "Conference Bridge"
},
{
"value": "Conference Bridge WS-X6608",
"title": "Conference Bridge WS-X6608"
},
{
"value": "Cisco IOS Conference Bridge (HDV2)",
"title": "Cisco IOS Conference Bridge (HDV2)"
},
{
"value": "Cisco Conference Bridge (WS-SVC-CMM)",
"title": "Cisco Conference Bridge (WS-SVC-CMM)"
},
{
"value": "H.323 Phone",
"title": "H.323 Phone"
},
{
"value": "H.323 Gateway",
"title": "H.323 Gateway"
},
{
"value": "Music On Hold",
"title": "Music On Hold"
},
{
"value": "Device Pilot",
"title": "Device Pilot"
},
{
"value": "CTI Port",
"title": "CTI Port"
},
{
"value": "CTI Route Point",
"title": "CTI Route Point"
},
{
"value": "Voice Mail Port",
"title": "Voice Mail Port"
},
{
"value": "Cisco IOS Software Media Termination Point (HDV2)",
"title": "Cisco IOS Software Media Termination Point (HDV2)"
},
{
"value": "Cisco Media Server (WS-SVC-CMM-MS)",
"title": "Cisco Media Server (WS-SVC-CMM-MS)"
},
{
"value": "Cisco Video Conference Bridge (IPVC-35xx)",
"title": "Cisco Video Conference Bridge (IPVC-35xx)"
},
{
"value": "Cisco IOS Heterogeneous Video Conference Bridge",
"title": "Cisco IOS Heterogeneous Video Conference Bridge"
},
{
"value": "Cisco IOS Guaranteed Audio Video Conference Bridge",
"title": "Cisco IOS Guaranteed Audio Video Conference Bridge"
},
{
"value": "Cisco IOS Homogeneous Video Conference Bridge",
"title": "Cisco IOS Homogeneous Video Conference Bridge"
},
{
"value": "Route List",
"title": "Route List"
},
{
"value": "Load Simulator",
"title": "Load Simulator"
},
{
"value": "Media Termination Point",
"title": "Media Termination Point"
},
{
"value": "Media Termination Point Hardware",
"title": "Media Termination Point Hardware"
},
{
"value": "Cisco IOS Media Termination Point (HDV2)",
"title": "Cisco IOS Media Termination Point (HDV2)"
},
{
"value": "Cisco Media Termination Point (WS-SVC-CMM)",
"title": "Cisco Media Termination Point (WS-SVC-CMM)"
},
{
"value": "Cisco 7941",
"title": "Cisco 7941"
},
{
"value": "Cisco 7971",
"title": "Cisco 7971"
},
{
"value": "MGCP Station",
"title": "MGCP Station"
},
{
"value": "MGCP Trunk",
"title": "MGCP Trunk"
},
{
"value": "GateKeeper",
"title": "GateKeeper"
},
{
"value": "7914 14-Button Line Expansion Module",
"title": "7914 14-Button Line Expansion Module"
},
{
"value": "Trunk",
"title": "Trunk"
},
{
"value": "Tone Announcement Player",
"title": "Tone Announcement Player"
},
{
"value": "SIP Trunk",
"title": "SIP Trunk"
},
{
"value": "SIP Gateway",
"title": "SIP Gateway"
},
{
"value": "WSM Trunk",
"title": "WSM Trunk"
},
{
"value": "Remote Destination Profile",
"title": "Remote Destination Profile"
},
{
"value": "7915 12-Button Line Expansion Module",
"title": "7915 12-Button Line Expansion Module"
},
{
"value": "7915 24-Button Line Expansion Module",
"title": "7915 24-Button Line Expansion Module"
},
{
"value": "7916 12-Button Line Expansion Module",
"title": "7916 12-Button Line Expansion Module"
},
{
"value": "7916 24-Button Line Expansion Module",
"title": "7916 24-Button Line Expansion Module"
},
{
"value": "CKEM 36-Button Line Expansion Module",
"title": "CKEM 36-Button Line Expansion Module"
},
{
"value": "SPA8800",
"title": "SPA8800"
},
{
"value": "Unknown MGCP Gateway",
"title": "Unknown MGCP Gateway"
},
{
"value": "Unknown",
"title": "Unknown"
},
{
"value": "Cisco 7985",
"title": "Cisco 7985"
},
{
"value": "Cisco 7911",
"title": "Cisco 7911"
},
{
"value": "Cisco 7961G-GE",
"title": "Cisco 7961G-GE"
},
{
"value": "Cisco 7941G-GE",
"title": "Cisco 7941G-GE"
},
{
"value": "Motorola CN622",
"title": "Motorola CN622"
},
{
"value": "Third-party SIP Device (Basic)",
"title": "Third-party SIP Device (Basic)"
},
{
"value": "Cisco 7931",
"title": "Cisco 7931"
},
{
"value": "Cisco Unified Personal Communicator",
"title": "Cisco Unified Personal Communicator"
},
{
"value": "Cisco 7921",
"title": "Cisco 7921"
},
{
"value": "Cisco 7906",
"title": "Cisco 7906"
},
{
"value": "Third-party SIP Device (Advanced)",
"title": "Third-party SIP Device (Advanced)"
},
{
"value": "Cisco TelePresence",
"title": "Cisco TelePresence"
},
{
"value": "Nokia S60",
"title": "Nokia S60"
},
{
"value": "Cisco 7962",
"title": "Cisco 7962"
},
{
"value": "Cisco 3951",
"title": "Cisco 3951"
},
{
"value": "Cisco 7937",
"title": "Cisco 7937"
},
{
"value": "Cisco 7942",
"title": "Cisco 7942"
},
{
"value": "Cisco 7945",
"title": "Cisco 7945"
},
{
"value": "Cisco 7965",
"title": "Cisco 7965"
},
{
"value": "Cisco 7975",
"title": "Cisco 7975"
},
{
"value": "Cisco 3911",
"title": "Cisco 3911"
},
{
"value": "Cisco Unified Mobile Communicator",
"title": "Cisco Unified Mobile Communicator"
},
{
"value": "Cisco TelePresence 1000",
"title": "Cisco TelePresence 1000"
},
{
"value": "Cisco TelePresence 3000",
"title": "Cisco TelePresence 3000"
},
{
"value": "Cisco TelePresence 3200",
"title": "Cisco TelePresence 3200"
},
{
"value": "Cisco TelePresence 500-37",
"title": "Cisco TelePresence 500-37"
},
{
"value": "Cisco 7925",
"title": "Cisco 7925"
},
{
"value": "Cisco 9971",
"title": "Cisco 9971"
},
{
"value": "Cisco 6921",
"title": "Cisco 6921"
},
{
"value": "Cisco 6941",
"title": "Cisco 6941"
},
{
"value": "Cisco 6961",
"title": "Cisco 6961"
},
{
"value": "Cisco Unified Client Services Framework",
"title": "Cisco Unified Client Services Framework"
},
{
"value": "Cisco TelePresence 1300-65",
"title": "Cisco TelePresence 1300-65"
},
{
"value": "Cisco TelePresence 1100",
"title": "Cisco TelePresence 1100"
},
{
"value": "Transnova S3",
"title": "Transnova S3"
},
{
"value": "BlackBerry MVS VoWifi",
"title": "BlackBerry MVS VoWifi"
},
{
"value": "Cisco 9951",
"title": "Cisco 9951"
},
{
"value": "Cisco 8961",
"title": "Cisco 8961"
},
{
"value": "Cisco 6901",
"title": "Cisco 6901"
},
{
"value": "Cisco 6911",
"title": "Cisco 6911"
},
{
"value": "Cisco ATA 187",
"title": "Cisco ATA 187"
},
{
"value": "Cisco TelePresence 200",
"title": "Cisco TelePresence 200"
},
{
"value": "Cisco TelePresence 400",
"title": "Cisco TelePresence 400"
},
{
"value": "Cisco Dual Mode for iPhone",
"title": "Cisco Dual Mode for iPhone"
},
{
"value": "Cisco 6945",
"title": "Cisco 6945"
},
{
"value": "Cisco Dual Mode for Android",
"title": "Cisco Dual Mode for Android"
},
{
"value": "Cisco 7926",
"title": "Cisco 7926"
},
{
"value": "Cisco E20",
"title": "Cisco E20"
},
{
"value": "Generic Single Screen Room System",
"title": "Generic Single Screen Room System"
},
{
"value": "Generic Multiple Screen Room System",
"title": "Generic Multiple Screen Room System"
},
{
"value": "Cisco TelePresence EX90",
"title": "Cisco TelePresence EX90"
},
{
"value": "Cisco 8945",
"title": "Cisco 8945"
},
{
"value": "Cisco 8941",
"title": "Cisco 8941"
},
{
"value": "Generic Desktop Video Endpoint",
"title": "Generic Desktop Video Endpoint"
},
{
"value": "Cisco TelePresence 500-32",
"title": "Cisco TelePresence 500-32"
},
{
"value": "Cisco TelePresence 1300-47",
"title": "Cisco TelePresence 1300-47"
},
{
"value": "Cisco 3905",
"title": "Cisco 3905"
},
{
"value": "Cisco Cius",
"title": "Cisco Cius"
},
{
"value": "VKEM 36-Button Line Expansion Module",
"title": "VKEM 36-Button Line Expansion Module"
},
{
"value": "Cisco TelePresence TX1310-65",
"title": "Cisco TelePresence TX1310-65"
},
{
"value": "Cisco TelePresence MCU",
"title": "Cisco TelePresence MCU"
},
{
"value": "Ascom IP-DECT Device",
"title": "Ascom IP-DECT Device"
},
{
"value": "Cisco TelePresence Exchange System",
"title": "Cisco TelePresence Exchange System"
},
{
"value": "Cisco TelePresence EX60",
"title": "Cisco TelePresence EX60"
},
{
"value": "Cisco TelePresence Codec C90",
"title": "Cisco TelePresence Codec C90"
},
{
"value": "Cisco TelePresence Codec C60",
"title": "Cisco TelePresence Codec C60"
},
{
"value": "Cisco TelePresence Codec C40",
"title": "Cisco TelePresence Codec C40"
},
{
"value": "Cisco TelePresence Quick Set C20",
"title": "Cisco TelePresence Quick Set C20"
},
{
"value": "Cisco TelePresence Profile 42 (C20)",
"title": "Cisco TelePresence Profile 42 (C20)"
},
{
"value": "Cisco TelePresence Profile 42 (C60)",
"title": "Cisco TelePresence Profile 42 (C60)"
},
{
"value": "Cisco TelePresence Profile 52 (C40)",
"title": "Cisco TelePresence Profile 52 (C40)"
},
{
"value": "Cisco TelePresence Profile 52 (C60)",
"title": "Cisco TelePresence Profile 52 (C60)"
},
{
"value": "Cisco TelePresence Profile 52 Dual (C60)",
"title": "Cisco TelePresence Profile 52 Dual (C60)"
},
{
"value": "Cisco TelePresence Profile 65 (C60)",
"title": "Cisco TelePresence Profile 65 (C60)"
},
{
"value": "Cisco TelePresence Profile 65 Dual (C90)",
"title": "Cisco TelePresence Profile 65 Dual (C90)"
},
{
"value": "Cisco TelePresence MX200",
"title": "Cisco TelePresence MX200"
},
{
"value": "Cisco TelePresence TX9000",
"title": "Cisco TelePresence TX9000"
},
{
"value": "Cisco TelePresence TX9200",
"title": "Cisco TelePresence TX9200"
},
{
"value": "Cisco 7821",
"title": "Cisco 7821"
},
{
"value": "Cisco 7841",
"title": "Cisco 7841"
},
{
"value": "Cisco 7861",
"title": "Cisco 7861"
},
{
"value": "Cisco TelePresence SX20",
"title": "Cisco TelePresence SX20"
},
{
"value": "Cisco TelePresence MX300",
"title": "Cisco TelePresence MX300"
},
{
"value": "IMS-integrated Mobile (Basic)",
"title": "IMS-integrated Mobile (Basic)"
},
{
"value": "Third-party AS-SIP Endpoint",
"title": "Third-party AS-SIP Endpoint"
},
{
"value": "Cisco Cius SP",
"title": "Cisco Cius SP"
},
{
"value": "Cisco TelePresence Profile 42 (C40)",
"title": "Cisco TelePresence Profile 42 (C40)"
},
{
"value": "Cisco VXC 6215",
"title": "Cisco VXC 6215"
},
{
"value": "CTI Remote Device",
"title": "CTI Remote Device"
},
{
"value": "Usage Profile",
"title": "Usage Profile"
},
{
"value": "Carrier-integrated Mobile",
"title": "Carrier-integrated Mobile"
},
{
"value": "Universal Device Template",
"title": "Universal Device Template"
},
{
"value": "Cisco DX650",
"title": "Cisco DX650"
},
{
"value": "Cisco Unified Communications for RTX",
"title": "Cisco Unified Communications for RTX"
},
{
"value": "Cisco Jabber for Tablet",
"title": "Cisco Jabber for Tablet"
},
{
"value": "Cisco 8831",
"title": "Cisco 8831"
},
{
"value": "Cisco ATA 190",
"title": "Cisco ATA 190"
},
{
"value": "Cisco TelePresence SX10",
"title": "Cisco TelePresence SX10"
},
{
"value": "Cisco 8841",
"title": "Cisco 8841"
},
{
"value": "Cisco 8851",
"title": "Cisco 8851"
},
{
"value": "Cisco 8861",
"title": "Cisco 8861"
},
{
"value": "Cisco TelePresence SX80",
"title": "Cisco TelePresence SX80"
},
{
"value": "Cisco TelePresence MX200 G2",
"title": "Cisco TelePresence MX200 G2"
},
{
"value": "Cisco TelePresence MX300 G2",
"title": "Cisco TelePresence MX300 G2"
},
{
"value": "Cisco 7905",
"title": "Cisco 7905"
},
{
"value": "Cisco 7920",
"title": "Cisco 7920"
},
{
"value": "Cisco 7970",
"title": "Cisco 7970"
},
{
"value": "Cisco 7912",
"title": "Cisco 7912"
},
{
"value": "Cisco 7902",
"title": "Cisco 7902"
},
{
"value": "Cisco IP Communicator",
"title": "Cisco IP Communicator"
},
{
"value": "Cisco 7961",
"title": "Cisco 7961"
},
{
"value": "Cisco 7936",
"title": "Cisco 7936"
},
{
"value": "Analog Phone",
"title": "Analog Phone"
},
{
"value": "ISDN BRI Phone",
"title": "ISDN BRI Phone"
},
{
"value": "SCCP gateway virtual phone",
"title": "SCCP gateway virtual phone"
},
{
"value": "IP-STE",
"title": "IP-STE"
},
{
"value": "Cisco TelePresence Conductor",
"title": "Cisco TelePresence Conductor"
},
{
"value": "Cisco DX80",
"title": "Cisco DX80"
},
{
"value": "Cisco DX70",
"title": "Cisco DX70"
},
{
"value": "BEKEM 36-Button Line Expansion Module",
"title": "BEKEM 36-Button Line Expansion Module"
},
{
"value": "Cisco TelePresence MX700",
"title": "Cisco TelePresence MX700"
},
{
"value": "Cisco TelePresence MX800",
"title": "Cisco TelePresence MX800"
},
{
"value": "Cisco TelePresence IX5000",
"title": "Cisco TelePresence IX5000"
},
{
"value": "Cisco 7811",
"title": "Cisco 7811"
},
{
"value": "Cisco 8821",
"title": "Cisco 8821"
},
{
"value": "Cisco 8811",
"title": "Cisco 8811"
},
{
"value": "Interactive Voice Response",
"title": "Interactive Voice Response"
},
{
"value": "Cisco 8845",
"title": "Cisco 8845"
},
{
"value": "Cisco 8865",
"title": "Cisco 8865"
},
{
"value": "Cisco TelePresence MX800 Dual",
"title": "Cisco TelePresence MX800 Dual"
},
{
"value": "Cisco 8851NR",
"title": "Cisco 8851NR"
},
{
"value": "Cisco Spark Remote Device",
"title": "Cisco Spark Remote Device"
},
{
"value": "Cisco Webex DX80",
"title": "Cisco Webex DX80"
},
{
"value": "Cisco TelePresence DX70",
"title": "Cisco TelePresence DX70"
},
{
"value": "Cisco 7832",
"title": "Cisco 7832"
},
{
"value": "Cisco 8865NR",
"title": "Cisco 8865NR"
},
{
"value": "Cisco Meeting Server",
"title": "Cisco Meeting Server"
},
{
"value": "Cisco Webex Room Kit",
"title": "Cisco Webex Room Kit"
},
{
"value": "Cisco Webex Room 55",
"title": "Cisco Webex Room 55"
},
{
"value": "Cisco Webex Room Kit Plus",
"title": "Cisco Webex Room Kit Plus"
},
{
"value": "CP-8800-Video 28-Button Key Expansion Module",
"title": "CP-8800-Video 28-Button Key Expansion Module"
},
{
"value": "CP-8800-Audio 28-Button Key Expansion Module",
"title": "CP-8800-Audio 28-Button Key Expansion Module"
},
{
"value": "Cisco 8832",
"title": "Cisco 8832"
},
{
"value": "Cisco Webex Room 70 Single",
"title": "Cisco Webex Room 70 Single"
},
{
"value": "Cisco 8832NR",
"title": "Cisco 8832NR"
},
{
"value": "Cisco ATA 191",
"title": "Cisco ATA 191"
},
{
"value": "Cisco Collaboration Mobile Convergence",
"title": "Cisco Collaboration Mobile Convergence"
},
{
"value": "Cisco Webex Room 70 Dual",
"title": "Cisco Webex Room 70 Dual"
},
{
"value": "Cisco Webex Room 55 Dual",
"title": "Cisco Webex Room 55 Dual"
},
{
"value": "Cisco Webex Room 70 Single G2",
"title": "Cisco Webex Room 70 Single G2"
},
{
"value": "Cisco Webex Room 70 Dual G2",
"title": "Cisco Webex Room 70 Dual G2"
},
{
"value": "Cisco Webex Room Kit Mini",
"title": "Cisco Webex Room Kit Mini"
}
],
"maxItems": 1,
"type": [
"string",
"null"
]
},
"sipPhonePort": {
"description": "\n This setting applies to phones that are running SIP that use UDP transport. \n Enter the port number for \n Cisco Unified IP Phones (SIP only) that use UDP to listen for SIP messages from \n Cisco Unified Communications Manager. The default setting equals 5060. \n Phones that use TCP or TLS ignore this setting. ",
"title": "SIP Phone Port",
"minItems": 0,
"required": false,
"default": 5060,
"maxItems": 1,
"type": "integer"
},
"transportType": {
"description": "\n When Device Security Mode is Non Secure, choose one of the following options from the drop-down list box (some options may not display): \n \n \n TCP\u2014Choose the Transmission Control Protocol to ensure that packets get received in the same order as the order in which they are sent. This protocol ensures that no packets get dropped, but the protocol does not provide any security. \n \n UDP\u2014Choose the User Datagram Protocol to ensure that packets are received quickly. This protocol, which can drop packets, does not ensure that packets are received in the order in which they are sent. This protocol does not provide any security. \n \n TCP + UDP\u2014Choose this option if you want to use a combination of TCP and UDP. This option does not provide any security. \n \n When Device Security Mode is Authenticated or Encrypted, TLS specifies the Transport Type. TLS provides signaling integrity, device authentication, and signaling encryption (encrypted mode only) for SIP\u00a0phones. \n If Device Security Mode cannot be configured in the profile, the transport type specifies UDP. ",
"title": "Transport Type",
"minItems": 0,
"required": false,
"choices": [
{
"value": "TCP",
"title": "TCP"
},
{
"value": "UDP",
"title": "UDP"
},
{
"value": "TLS",
"title": "TLS"
},
{
"value": "TCP+UDP",
"title": "TCP+UDP"
}
],
"default": "TCP+UDP",
"maxItems": 1,
"type": "string"
},
"protocol": {
"title": "Device Protocol",
"minItems": 1,
"required": true,
"choices": [
{
"value": "SCCP",
"title": "SCCP"
},
{
"value": "Digital Access PRI",
"title": "Digital Access PRI"
},
{
"value": "H.225",
"title": "H.225"
},
{
"value": "Analog Access",
"title": "Analog Access"
},
{
"value": "Digital Access T1",
"title": "Digital Access T1"
},
{
"value": "Route Point",
"title": "Route Point"
},
{
"value": "Unicast Bridge",
"title": "Unicast Bridge"
},
{
"value": "Multicast Point",
"title": "Multicast Point"
},
{
"value": "Inter-Cluster Trunk",
"title": "Inter-Cluster Trunk"
},
{
"value": "RAS",
"title": "RAS"
},
{
"value": "Digital Access BRI",
"title": "Digital Access BRI"
},
{
"value": "SIP",
"title": "SIP"
},
{
"value": "MGCP",
"title": "MGCP"
},
{
"value": "Static SIP Mobile Subscriber",
"title": "Static SIP Mobile Subscriber"
},
{
"value": "SIP Connector",
"title": "SIP Connector"
},
{
"value": "Remote Destination",
"title": "Remote Destination"
},
{
"value": "Mobile Smart Client",
"title": "Mobile Smart Client"
},
{
"value": "Digital Access E1 R2",
"title": "Digital Access E1 R2"
},
{
"value": "CTI Remote Device",
"title": "CTI Remote Device"
},
{
"value": "Protocol Not Specified",
"title": "Protocol Not Specified"
}
],
"maxItems": 1,
"type": [
"string",
"null"
]
},
"name": {
"description": "\n Enter a name for the security profile. \n When you save the new profile, the name displays in the Device Security Profile drop-down list box in the Phone Configuration window for the phone type and protocol. \n \n \n \n Tip\u00a0\u00a0\u00a0 \n Include the device model and protocol in the security profile name to help you find the correct profile when you are searching for or updating a profile.\n \n \n ",
"title": "Name",
"minItems": 1,
"required": true,
"maxItems": 1,
"type": "string"
},
"tftpEncryptedConfig": {
"description": "\n When this check box is checked, \n Cisco Unified Communications Manager encrypts phone downloads from the TFTP server. This option exists for Cisco phones only. \n \n \n \n Tip\u00a0\u00a0\u00a0 \n Cisco recommends that you enable this option and configure a symmetric key to secure digest credentials and administrative passwords.\n \n \n ",
"title": "TFTP Encrypted Config",
"minItems": 0,
"required": false,
"default": false,
"maxItems": 1,
"type": "boolean"
},
"enableDigestAuthentication": {
"description": "\n If you check this check box, \n Cisco Unified Communications Manager challenges all SIP requests from the phone. \n Digest authentication does not provide device authentication, integrity, or confidentiality. Choose a security mode of authenticated or encrypted to use these features. ",
"title": "Enable Digest Authentication",
"minItems": 0,
"required": false,
"default": false,
"maxItems": 1,
"type": "boolean"
},
"deviceSecurityMode": {
"description": "\n From the drop-down list box, choose one of the following options: \n \n \n Non Secure\u2014No security features except image, file, and device authentication exist for the phone. A TCP connection opens to \n Cisco Unified Communications Manager. \n \n Authenticated\u2014\n Cisco Unified Communications Manager provides integrity and authentication for the phone. A TLS connection that uses NULL/SHA opens for signaling. \n \n Encrypted\u2014\n Cisco Unified Communications Manager provides integrity, authentication, and encryption for the phone. A TLS connection that uses AES128/SHA opens for signaling, and SRTP carries the media for all phone calls on all SRTP-capable hops. \n ",
"title": "Device Security Mode",
"minItems": 0,
"required": false,
"choices": [
{
"value": "Non Secure",
"title": "Non Secure"
},
{
"value": "Authenticated",
"title": "Authenticated"
},
{
"value": "Encrypted",
"title": "Encrypted"
}
],
"maxItems": 1,
"type": [
"string",
"null"
]
},
"ecKeySize": {
"description": "\n For this setting that is used for CAPF, choose the key size for the certificate from the drop-down list box. The default setting equals 1024. The other option for key size is 512. \n If you choose a higher key size than the default setting, the phones take longer to generate the entropy that is required to generate the keys. Key generation, which is set at low priority, allows the phone to function while the action occurs. Depending on the phone model, you may notice that key generation takes up to 30 or more minutes to complete. \n \n \n \n Note\u00a0\u00a0\u00a0 \n The CAPF settings that are configured in the Phone Security Profile window interact with the CAPF parameters that are configured in the Phone Configuration window. \n \n \n ",
"title": "Ec Key Size",
"minItems": 0,
"required": false,
"choices": [
{
"value": "256",
"title": "256"
},
{
"value": "384",
"title": "384"
},
{
"value": "521",
"title": "521"
}
],
"maxItems": 1,
"type": "string"
},
"authenticationMode": {
"description": "\n This field allows you to choose the authentication method that the phone uses during the CAPF certificate operation. This option exists for Cisco phones only. \n From the drop-down list box, choose one of the following options: \n \n \n By Authentication String\u2014Installs/upgrades or troubleshoots a locally significant certificate only when the user enters the CAPF authentication string on the phone. \n \n By Null String\u2014 Installs/upgrades or troubleshoots a locally significant certificate without user intervention.This option provides no security; Cisco strongly recommends that you choose this option only for closed, secure environments. \n \n By Existing Certificate (Precedence to LSC)\u2014 Installs/upgrades or troubleshoots a locally significant certificate if a manufacture-installed certificate (MIC) or locally significant certificate (LSC) exists in the phone. If a LSC exists in the phone, authentication occurs via the LSC, regardless whether a MIC exists in the phone. If a LSC does not exist in the phone, but a MIC does exist, authentication occurs via the MIC. Before you choose this option, verify that a certificate exists in the phone. If you choose this option and no certificate exists in the phone, the operation fails. At any time, the phone uses only one certificate to authenticate to CAPF even though a MIC and LSC can exist in the phone at the same time. If the primary certificate, which takes precedence, becomes compromised for any reason, or, if you want to authenticate via the other certificate, you must update the authentication mode. \n \n By Existing Certificate (Precedence to MIC)\u2014Installs/upgrades or troubleshoots a locally significant certificate if a LSC or MIC exists in the phone. If a MIC exists in the phone, authentication occurs via the MIC, regardless whether a LSC exists in the phone. If a LSC exists in the phone, but a MIC does not exist, authentication occurs via the LSC. Before you choose this option, verify that a certificate exists in the phone. If you choose this option and no certificate exists in the phone, the operation fails. \n \n \n \n \n Note\u00a0\u00a0\u00a0 \n The CAPF settings that are configured in the Phone Security Profile window interact with the CAPF parameters that are configured in the Phone Configuration window. Refer to the \n \n \n ",
"title": "Authentication Mode",
"minItems": 0,
"required": false,
"choices": [
{
"value": "By Authentication String",
"title": "By Authentication String"
},
{
"value": "By Null String",
"title": "By Null String"
},
{
"value": "By Existing Certificate (precedence to LSC)",
"title": "By Existing Certificate (precedence to LSC)"
},
{
"value": "By Existing Certificate (precedence to MIC)",
"title": "By Existing Certificate (precedence to MIC)"
}
],
"default": "By Null String",
"maxItems": 1,
"type": "string"
},
"keySize": {
"description": "\n For this setting that is used for CAPF, choose the key size for the certificate from the drop-down list box. The default setting equals 1024. The other option for key size is 512. \n If you choose a higher key size than the default setting, the phones take longer to generate the entropy that is required to generate the keys. Key generation, which is set at low priority, allows the phone to function while the action occurs. Depending on the phone model, you may notice that key generation takes up to 30 or more minutes to complete. \n \n \n \n Note\u00a0\u00a0\u00a0 \n The CAPF settings that are configured in the Phone Security Profile window interact with the CAPF parameters that are configured in the Phone Configuration window. \n \n \n ",
"title": "Key Size (Bits)",
"minItems": 0,
"required": false,
"choices": [
{
"value": "512",
"title": "512"
},
{
"value": "1024",
"title": "1024"
},
{
"value": "2048",
"title": "2048"
},
{
"value": "3072",
"title": "3072"
},
{
"value": "4096",
"title": "4096"
}
],
"default": "2048",
"maxItems": 1,
"type": "string"
},
"keyOrder": {
"description": "Applicable only for sip phones",
"title": "Key Order",
"minItems": 0,
"required": false,
"choices": [
{
"value": "RSA Only",
"title": "RSA Only"
},
{
"value": "EC Only",
"title": "EC Only"
},
{
"value": "EC Preferred, RSA Backup",
"title": "EC Preferred, RSA Backup"
}
],
"default": "RSA Only",
"maxItems": 1,
"type": "string"
},
"nonceValidityTime": {
"description": "\n Enter the number of minutes (in seconds) that the nonce value is valid. The default value equals 600 (10 minutes). When the time expires, \n Cisco Unified Communications Manager generates a new value. \n \n \n \n Note\u00a0\u00a0\u00a0 \n A nonce value, a random number that supports digest authentication, gets used to calculate the MD5 hash of the digest authentication password. \n \n \n ",
"title": "Nonce Validity Time",
"minItems": 0,
"required": false,
"default": 600,
"maxItems": 1,
"type": "integer"
},
"EnableOAuthAuthentication": {
"description": "Applicable only for SIP phones",
"title": "Enable O Auth Authentication",
"minItems": 0,
"required": false,
"default": false,
"maxItems": 1,
"type": "boolean"
},
"excludeDigestCredentials": {
"description": "\n When this check box is checked, \n Cisco Unified Communications Manager omits digest credentials in phone downloads from the TFTP server. This option exists for \n Cisco Unified IP Phones 7905G, 7912G, 7940G, and 7960G (SIP only). ",
"title": "Exclude Digest Credentials in Configuration File",
"minItems": 0,
"required": false,
"default": false,
"maxItems": 1,
"type": "boolean"
},
"description": {
"description": "\n Enter a description for the security profile. ",
"title": "Description",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"string",
"null"
]
}
},
"schema_version": "12.5"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/device/cucm/PhoneSecurityProfile/add/ |
|
The GUI Add form of device/cucm/PhoneSecurityProfile as JSON |
The API call to the /add/ URL can only be made from a hierarchy that allows the model type to be added. The actions in the response shows the url for the POST API call to create an instance.
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Create | POST | /api/device/cucm/PhoneSecurityProfile/ | hierarchy=[hierarchy] |
|
tool/Transaction/[trans pkid]to inspect the created resource and its instance pkid.
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Bulk delete [pkid1],[pkid2]... | DELETE | /api/device/cucm/PhoneSecurityProfile/ | hierarchy=[hierarchy] | {"hrefs":["/api/device/cucm/PhoneSecurityProfile/[pkid1]", "/api/device/cucm/PhoneSecurityProfile/[pkid2]", ...]} |
GET http://[host-proxy]/api/device/cucm/PhoneSecurityProfile/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Bulk Modify | GET | /api/device/cucm/PhoneSecurityProfile/bulk_update/?schema=&schema_rules=true |
|
|
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Bulk Modify | POST | /api/device/cucm/PhoneSecurityProfile/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/cucm/PhoneSecurityProfile/[pkid1]", "/api/v0/device/cucm/PhoneSecurityProfile/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/cucm/PhoneSecurityProfile/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move the instance with [pkid] to [target_hierarchy] | POST | /api/tool/DataMove/?model_type=device/cucm/PhoneSecurityProfile |
|
{"hrefs": ["/api/device/cucm/PhoneSecurityProfile/[pkid]"]} |
| Bulk Move | POST | /api/tool/DataMove/?model_type=device/cucm/PhoneSecurityProfile |
|
{"hrefs": ["/api/device/cucm/PhoneSecurityProfile/[pkid1]", "/api/device/cucm/PhoneSecurityProfile/[pkid2]",...]} |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/cucm/PhoneSecurityProfile; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/cucm/PhoneSecurityProfile/export/ |
|
{ "hrefs":["/api/device/cucm/PhoneSecurityProfile/[pkid1]", "/api/device/cucm/PhoneSecurityProfile/[pkid2]",...]}} |
For export_format=json, the response is a time stamped zip file of data in JSON as in the system database. Item properties such as strings that are empty or Boolean values that are not set, are not included. The filename in the response is of the format as the example:
Content-Disposition: attachment; filename=export_2013-05-17_14:20:19.186444.json.zip
Content-Language:en
Content-Type:application/x-zip
For export_format=raw_xlsx, the response is a MS Excel spreadsheet with columns corresponding to the JSON format export and a response filename format:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_CCYY-MM-DD_HH-MM-SS.xlsx
Content-Language:en
Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
For export_format=xlsx, the response is a MS Excel spreadsheet, arranged by any Field Display Policies that apply. The columns correspond with those of a Bulk Load Template export sheet. The response filename format is:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_formatted_CCYY-MM-DD_HH-MM-SS.xlsx
Content-Language:en
Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
The XLSX format can be used to bulk load instances of device/cucm/PhoneSecurityProfile and the JSON format can be used to import instances of device/cucm/PhoneSecurityProfile.
GET http://[host-proxy]/api/device/cucm/PhoneSecurityProfile/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for device/cucm/PhoneSecurityProfile | POST | /api/device/cucm/PhoneSecurityProfile/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Configuration Template | GET | /api/device/cucm/PhoneSecurityProfile/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Field Display Policy | GET | /api/device/cucm/PhoneSecurityProfile/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/device/cucm/PhoneSecurityProfile/ |
|
The device/cucm/PhoneSecurityProfile schema and all instances as JSON. |
(The list will return 0 to 3 device/cucm/PhoneSecurityProfile instances)
{
"operations": [
"field_display_policy",
"configuration_template",
"help",
"get",
"clone",
"move",
"list",
"update",
"remove",
"bulk_update_form",
"add",
"transform",
"export",
"export_bulkload_template"
],
"pagination": {
"direction": "asc",
"order_by": "name",
"maximum_limit": 2000,
"skip": 0,
"current": "/api/device/cucm/PhoneSecurityProfile/?skip=0&limit=3&order_by=name&direction=asc&traversal=default",
"limit": 3,
"total_limit": null,
"total": 748
},
"meta": {
"tags": [],
"cached": true,
"title": "",
"business_key": {},
"schema_version": "12.5",
"references": {
"device": [
{
"pkid": "",
"href": ""
}
],
"children": [],
"parent": [
{
"pkid": "6t0ggef2c0deab00hb595101",
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101"
}
],
"foreign_key": []
},
"actions": [
{
"add": {
"support_async": false,
"class": "add",
"href": "/api/device/cucm/PhoneSecurityProfile/add/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Add"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/device/cucm/PhoneSecurityProfile/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"bulk_update_form": {
"support_async": false,
"class": "update",
"href": "/api/device/cucm/PhoneSecurityProfile/bulk_update/?hierarchy=[hierarchy]&schema=&schema_rules=true",
"method": "GET",
"title": "Bulk Modify"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/?hierarchy=[hierarchy]&model_type=device/cucm/PhoneSecurityProfile",
"method": "POST",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/cucm/PhoneSecurityProfile/export/?hierarchy=[hierarchy]",
"method": "POST",
"view": "/api/view/ExportData/add/?auth_token=[authtoken]
}
},
{
"export_bulkload_template": {
"support_async": false,
"class": "bulkload_template",
"href": "/api/device/cucm/PhoneSecurityProfile/export_bulkload_template/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Export Bulk Load Template"
}
},
{
"configuration_template": {
"support_async": false,
"class": "config",
"href": "/api/device/cucm/PhoneSecurityProfile/configuration_template/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Configuration Template"
}
},
{
"field_display_policy": {
"support_async": false,
"class": "display_policy",
"href": "/api/device/cucm/PhoneSecurityProfile/field_display_policy/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Field Display Policy"
}
},
{
"list": {
"support_async": false,
"class": "list",
"href": "/api/device/cucm/PhoneSecurityProfile/?hierarchy=[hierarchy]",
"method": "GET",
"title": "List"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/cucm/PhoneSecurityProfile/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/cucm/PhoneSecurityProfile/purge/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Purge"
}
}
],
"model_type": "device/cucm/PhoneSecurityProfile",
"model_specific_actions": [
"reset",
"configuration_template",
"field_display_policy",
"help",
"get",
"clone",
"move",
"list",
"update",
"remove",
"add",
"export",
"apply",
"export_bulkload_template",
"bulk_update_form"
],
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "description",
"title": "Description"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
},
{
"allow_filtering": false,
"name": "summary_device",
"title": "Device"
}
],
"api_version": "20.1.1",
"tagged_versions": []
},
"resources": [
{
"pkid": "5fff56e6ce894e0015507e15",
"meta": {
"tags": [],
"cached": true,
"title": "Analog Phone - Standard SCCP Non-Secure Profile",
"business_key": {},
"schema_version": "",
"summary": "false",
"references": {
"owner": [
{
"pkid": ""
}
],
"device": [
{
"pkid": "5fff5677ce894e0015506295",
"href": "/api/v0/data/CallManager/5fff5677ce894e0015506295"
}
],
"self": [
{
"pkid": "5fff56e6ce894e0015507e15",
"href": "/api/device/cucm/PhoneSecurityProfile/5fff56e6ce894e0015507e15/"
}
],
"parent": [
{
"pkid": "5fff560ace894e001550455c",
"href": "/api/data/HierarchyNode/5fff560ace894e001550455c"
}
],
"foreign_key": []
},
"actions": [
{
"update": {
"support_async": true,
"class": "update",
"href": "/api/device/cucm/PhoneSecurityProfile/5fff56e6ce894e0015507e15/",
"method": "PUT",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/device/cucm/PhoneSecurityProfile/5fff56e6ce894e0015507e15/",
"method": "DELETE",
"title": "Delete"
}
},
{
"clone": {
"support_async": false,
"class": "clone",
"href": "/api/device/cucm/PhoneSecurityProfile/5fff56e6ce894e0015507e15/clone/?schema=&schema_rules=true",
"method": "GET",
"title": "Clone"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/5fff56e6ce894e0015507e15/?model_type=device/cucm/PhoneSecurityProfile",
"method": "POST",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/cucm/PhoneSecurityProfile/5fff56e6ce894e0015507e15/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/device/cucm/PhoneSecurityProfile/5fff56e6ce894e0015507e15/",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/cucm/PhoneSecurityProfile/5fff56e6ce894e0015507e15/help",
"method": "GET",
"title": "Help"
}
},
{
"apply": {
"title": "Apply",
"support_async": true,
"method": "POST",
"href": "/api/device/cucm/PhoneSecurityProfile/5fff56e6ce894e0015507e15/+apply/",
"class": "custom",
"view": "/api/device/cucm/PhoneSecurityProfile/+apply/schema/"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/cucm/PhoneSecurityProfile/5fff56e6ce894e0015507e15/purge/",
"method": "POST",
"title": "Purge"
}
},
{
"reset": {
"title": "Reset",
"support_async": true,
"method": "POST",
"href": "/api/device/cucm/PhoneSecurityProfile/5fff56e6ce894e0015507e15/+reset/",
"class": "custom",
"view": "/api/device/cucm/PhoneSecurityProfile/+reset/schema/"
}
}
],
"model_type": "device/cucm/PhoneSecurityProfile",
"path": [
"6t0ggef2c0deab00hb595101",
"5fff24a2ce894e0015f6de4e",
"5fff560ace894e001550455c",
"5fff56e6ce894e0015507e15"
],
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "description",
"title": "Description"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
},
{
"allow_filtering": false,
"name": "summary_device",
"title": "Device"
}
],
"api_version": "20.1.1",
"tagged_versions": []
},
"data": {
"phoneType": "Analog Phone",
"sipPhonePort": 0,
"transportType": "TCP",
"protocol": "SCCP",
"name": "Analog Phone - Standard SCCP Non-Secure Profile",
"tftpEncryptedConfig": false,
"hierarchy": "5fff560ace894e001550455c",
"enableDigestAuthentication": false,
"deviceSecurityMode": "Non Secure",
"authenticationMode": "By Null String",
"keySize": "2048",
"keyOrder": "RSA Only",
"nonceValidityTime": 600,
"summary_device": "Shared CUCM, 192.168.100.17, 8443, hcs.CS-P",
"hierarchy_friendly_name": "CS-P (Provider)",
"hierarchy_path": "sys.hcs.CS-P",
"excludeDigestCredentials": false,
"description": "Analog Phone - Standard SCCP Non-Secure Profile"
}
},
{
"pkid": "5fff576ece894e0015509ac6",
"meta": {
"tags": [],
"cached": true,
"title": "Analog Phone - Standard SCCP Non-Secure Profile",
"business_key": {},
"schema_version": "",
"summary": "false",
"references": {
"owner": [
{
"pkid": ""
}
],
"device": [
{
"pkid": "5fff56abce894e0015506e8c",
"href": "/api/v0/data/CallManager/5fff56abce894e0015506e8c"
}
],
"self": [
{
"pkid": "5fff576ece894e0015509ac6",
"href": "/api/device/cucm/PhoneSecurityProfile/5fff576ece894e0015509ac6/"
}
],
"parent": [
{
"pkid": "5fff5657ce894e001550592f",
"href": "/api/data/HierarchyNode/5fff5657ce894e001550592f"
}
],
"foreign_key": []
},
"actions": [
{
"update": {
"support_async": true,
"href": "/api/device/cucm/PhoneSecurityProfile/5fff576ece894e0015509ac6/",
"title": "Modify",
"class": "update",
"method": "PUT"
}
},
{
"remove": {
"support_async": true,
"href": "/api/device/cucm/PhoneSecurityProfile/5fff576ece894e0015509ac6/",
"title": "Delete",
"class": "delete",
"method": "DELETE"
}
},
{
"clone": {
"support_async": false,
"href": "/api/device/cucm/PhoneSecurityProfile/5fff576ece894e0015509ac6/clone/?schema=&schema_rules=true",
"title": "Clone",
"class": "clone",
"method": "GET"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/5fff576ece894e0015509ac6/?model_type=device/cucm/PhoneSecurityProfile",
"method": "POST",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/cucm/PhoneSecurityProfile/5fff576ece894e0015509ac6/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"get": {
"support_async": false,
"href": "/api/device/cucm/PhoneSecurityProfile/5fff576ece894e0015509ac6/",
"title": "Get",
"class": "get",
"method": "GET"
}
},
{
"help": {
"support_async": false,
"href": "/api/device/cucm/PhoneSecurityProfile/5fff576ece894e0015509ac6/help",
"title": "Help",
"class": "help",
"method": "GET"
}
},
{
"apply": {
"title": "Apply",
"support_async": true,
"class": "custom",
"href": "/api/device/cucm/PhoneSecurityProfile/5fff576ece894e0015509ac6/+apply/",
"method": "POST",
"view": "/api/device/cucm/PhoneSecurityProfile/+apply/schema/"
}
},
{
"purge": {
"support_async": false,
"href": "/api/device/cucm/PhoneSecurityProfile/5fff576ece894e0015509ac6/purge/",
"title": "Purge",
"class": "purge",
"method": "POST"
}
},
{
"reset": {
"title": "Reset",
"support_async": true,
"class": "custom",
"href": "/api/device/cucm/PhoneSecurityProfile/5fff576ece894e0015509ac6/+reset/",
"method": "POST",
"view": "/api/device/cucm/PhoneSecurityProfile/+reset/schema/"
}
}
],
"model_type": "device/cucm/PhoneSecurityProfile",
"path": [
"6t0ggef2c0deab00hb595101",
"5fff24a2ce894e0015f6de4e",
"5fff560ace894e001550455c",
"5fff5649ce894e001550558f",
"5fff5657ce894e001550592f",
"5fff576ece894e0015509ac6"
],
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "description",
"title": "Description"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
},
{
"allow_filtering": false,
"name": "summary_device",
"title": "Device"
}
],
"api_version": "20.1.1",
"tagged_versions": []
},
"data": {
"phoneType": "Analog Phone",
"sipPhonePort": 0,
"transportType": "TCP",
"protocol": "SCCP",
"name": "Analog Phone - Standard SCCP Non-Secure Profile",
"tftpEncryptedConfig": false,
"hierarchy": "5fff5657ce894e001550592f",
"enableDigestAuthentication": false,
"deviceSecurityMode": "Non Secure",
"authenticationMode": "By Null String",
"keySize": "2048",
"EnableOAuthAuthentication": false,
"keyOrder": "RSA Only",
"nonceValidityTime": 600,
"summary_device": "Dedicated CUCM, 192.168.100.15, 8443, hcs.CS-P.CS-NB.AAAGlobal",
"hierarchy_friendly_name": "AAAGlobal (Customer)",
"hierarchy_path": "sys.hcs.CS-P.CS-NB.AAAGlobal",
"excludeDigestCredentials": false,
"description": "Analog Phone - Standard SCCP Non-Secure Profile"
}
},
{
"pkid": "5fff582bce894e001550c6cf",
"meta": {
"tags": [],
"cached": true,
"title": "Analog Phone - Standard SCCP Non-Secure Profile",
"business_key": {},
"schema_version": "",
"summary": "false",
"references": {
"owner": [
{
"pkid": ""
}
],
"device": [
{
"pkid": "5fff56f3ce894e00155080b5",
"href": "/api/v0/data/CallManager/5fff56f3ce894e00155080b5"
}
],
"self": [
{
"pkid": "5fff582bce894e001550c6cf",
"href": "/api/device/cucm/PhoneSecurityProfile/5fff582bce894e001550c6cf/"
}
],
"parent": [
{
"pkid": "5fff5657ce894e001550592f",
"href": "/api/data/HierarchyNode/5fff5657ce894e001550592f"
}
],
"foreign_key": []
},
"actions": [
{
"update": {
"support_async": true,
"method": "PUT",
"href": "/api/device/cucm/PhoneSecurityProfile/5fff582bce894e001550c6cf/",
"class": "update",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"method": "DELETE",
"href": "/api/device/cucm/PhoneSecurityProfile/5fff582bce894e001550c6cf/",
"class": "delete",
"title": "Delete"
}
},
{
"clone": {
"support_async": false,
"method": "GET",
"href": "/api/device/cucm/PhoneSecurityProfile/5fff582bce894e001550c6cf/clone/?schema=&schema_rules=true",
"class": "clone",
"title": "Clone"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"method": "POST",
"href": "/api/tool/DataMove/5fff582bce894e001550c6cf/?model_type=device/cucm/PhoneSecurityProfile",
"class": "move",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"method": "GET",
"href": "/api/device/cucm/PhoneSecurityProfile/5fff582bce894e001550c6cf/export/",
"class": "export",
"view": "/api/view/ExportData/add/"
}
},
{
"get": {
"support_async": false,
"method": "GET",
"href": "/api/device/cucm/PhoneSecurityProfile/5fff582bce894e001550c6cf/",
"class": "get",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"method": "GET",
"href": "/api/device/cucm/PhoneSecurityProfile/5fff582bce894e001550c6cf/help",
"class": "help",
"title": "Help"
}
},
{
"apply": {
"title": "Apply",
"support_async": true,
"class": "custom",
"href": "/api/device/cucm/PhoneSecurityProfile/5fff582bce894e001550c6cf/+apply/",
"method": "POST",
"view": "/api/device/cucm/PhoneSecurityProfile/+apply/schema/"
}
},
{
"purge": {
"support_async": false,
"method": "POST",
"href": "/api/device/cucm/PhoneSecurityProfile/5fff582bce894e001550c6cf/purge/",
"class": "purge",
"title": "Purge"
}
},
{
"reset": {
"title": "Reset",
"support_async": true,
"class": "custom",
"href": "/api/device/cucm/PhoneSecurityProfile/5fff582bce894e001550c6cf/+reset/",
"method": "POST",
"view": "/api/device/cucm/PhoneSecurityProfile/+reset/schema/"
}
}
],
"model_type": "device/cucm/PhoneSecurityProfile",
"path": [
"6t0ggef2c0deab00hb595101",
"5fff24a2ce894e0015f6de4e",
"5fff560ace894e001550455c",
"5fff5649ce894e001550558f",
"5fff5657ce894e001550592f",
"5fff582bce894e001550c6cf"
],
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "description",
"title": "Description"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
},
{
"allow_filtering": false,
"name": "summary_device",
"title": "Device"
}
],
"api_version": "20.1.1",
"tagged_versions": []
},
"data": {
"phoneType": "Analog Phone",
"sipPhonePort": 0,
"transportType": "TCP",
"protocol": "SCCP",
"name": "Analog Phone - Standard SCCP Non-Secure Profile",
"tftpEncryptedConfig": false,
"hierarchy": "5fff5657ce894e001550592f",
"enableDigestAuthentication": false,
"deviceSecurityMode": "Non Secure",
"authenticationMode": "By Null String",
"keySize": "2048",
"EnableOAuthAuthentication": false,
"keyOrder": "RSA Only",
"nonceValidityTime": 600,
"summary_device": "Dedicated CUCM, 192.168.100.16, 8443, hcs.CS-P.CS-NB.AAAGlobal",
"hierarchy_friendly_name": "AAAGlobal (Customer)",
"hierarchy_path": "sys.hcs.CS-P.CS-NB.AAAGlobal",
"excludeDigestCredentials": false,
"description": "Analog Phone - Standard SCCP Non-Secure Profile"
}
}
]
}
(Show the first instance)
{
"pkid": "5fff56e6ce894e0015507e15",
"meta": {
"tags": [],
"cached": true,
"cache_control_policy": "cache_then_device",
"title": "Analog Phone - Standard SCCP Non-Secure Profile",
"business_key": {},
"schema_version": "11.5",
"references": {
"parent": [
{
"pkid": "5fff560ace894e001550455c",
"href": "/api/data/HierarchyNode/5fff560ace894e001550455c"
}
],
"self": [
{
"pkid": "5fff56e6ce894e0015507e15",
"href": "/api/device/cucm/PhoneSecurityProfile/5fff56e6ce894e0015507e15/"
}
],
"foreign_key": [],
"owner": [
{
"pkid": ""
}
],
"device": [
{
"pkid": "5fff5677ce894e0015506295",
"href": "/api/v0/data/CallManager/5fff5677ce894e0015506295"
}
],
"children": []
},
"actions": [
{
"update": {
"support_async": true,
"class": "update",
"href": "/api/device/cucm/PhoneSecurityProfile/5fff56e6ce894e0015507e15/?hierarchy=[hierarchy]",
"method": "PUT",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/device/cucm/PhoneSecurityProfile/5fff56e6ce894e0015507e15/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"clone": {
"support_async": false,
"class": "clone",
"href": "/api/device/cucm/PhoneSecurityProfile/5fff56e6ce894e0015507e15/clone/?hierarchy=[hierarchy]&schema=&schema_rules=true",
"method": "GET",
"title": "Clone"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/5fff56e6ce894e0015507e15/?hierarchy=[hierarchy]&model_type=device/cucm/PhoneSecurityProfile",
"method": "POST",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/cucm/PhoneSecurityProfile/5fff56e6ce894e0015507e15/export/?hierarchy=[hierarchy]",
"method": "GET",
"view": "/api/view/ExportData/add/?auth_token=[authtoken]
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/device/cucm/PhoneSecurityProfile/5fff56e6ce894e0015507e15/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/cucm/PhoneSecurityProfile/5fff56e6ce894e0015507e15/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
},
{
"apply": {
"title": "Apply",
"support_async": true,
"method": "POST",
"href": "/api/device/cucm/PhoneSecurityProfile/5fff56e6ce894e0015507e15/+apply/?hierarchy=[hierarchy]",
"class": "custom",
"view": "/api/device/cucm/PhoneSecurityProfile/+apply/schema/?auth_token=[authtoken]
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/cucm/PhoneSecurityProfile/5fff56e6ce894e0015507e15/purge/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Purge"
}
},
{
"reset": {
"title": "Reset",
"support_async": true,
"method": "POST",
"href": "/api/device/cucm/PhoneSecurityProfile/5fff56e6ce894e0015507e15/+reset/?hierarchy=[hierarchy]",
"class": "custom",
"view": "/api/device/cucm/PhoneSecurityProfile/+reset/schema/?auth_token=[authtoken]
}
}
],
"model_type": "device/cucm/PhoneSecurityProfile",
"path": [
"6t0ggef2c0deab00hb595101",
"5fff24a2ce894e0015f6de4e",
"5fff560ace894e001550455c",
"5fff56e6ce894e0015507e15"
],
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "description",
"title": "Description"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
},
{
"allow_filtering": false,
"name": "summary_device",
"title": "Device"
}
],
"api_version": "20.1.1",
"tagged_versions": []
},
"data": {
"sipPhonePort": 0,
"transportType": "TCP",
"protocol": "SCCP",
"description": "Analog Phone - Standard SCCP Non-Secure Profile",
"name": "Analog Phone - Standard SCCP Non-Secure Profile",
"tftpEncryptedConfig": false,
"enableDigestAuthentication": false,
"authenticationMode": "By Null String",
"keySize": "2048",
"keyOrder": "RSA Only",
"phoneType": "Analog Phone",
"deviceSecurityMode": "Non Secure",
"excludeDigestCredentials": false,
"nonceValidityTime": 600
}
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for device/cucm/PhoneSecurityProfile. | GET | /api/device/cucm/PhoneSecurityProfile/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/cucm/PhoneSecurityProfile as HTML |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/device/cucm/PhoneSecurityProfile/[pkid]/ | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Delete | DELETE | /api/device/cucm/PhoneSecurityProfile/[pkid]/ | hierarchy=[hierarchy] |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Clone instance with [pkid]. The schema rules are applied. | GET | /api/device/cucm/PhoneSecurityProfile/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/device/cucm/PhoneSecurityProfile/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/cucm/PhoneSecurityProfile | hierarchy=[hierarchy] | If payload required: |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and a single instance with [pkid] of device/cucm/PhoneSecurityProfile; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/cucm/PhoneSecurityProfile/[pkid]/export/ |
|
The response is an attachment. Refer to the list below. |
For export_format=raw_xlsx, the response is a "raw" MS Excel spreadsheet with columns corresponding to the JSON format export and a response format:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_CCYY-MM-DD_HH-MM-SS.xlsx
Content-Language:en
Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
For export_format=xlsx, the response is a MS Excel spreadsheet, formatted to show all columns and a response format:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_formatted_CCYY-MM-DD_HH-MM-SS.xlsx
Content-Language:en
Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
For export_format=json, the response is a time stamped zip file of data in JSON and a response format:
Content-Disposition: attachment; filename=export_2013-05-17_14:20:19.186444.json.zip
Content-Language:en
Content-Type:application/x-zip
The XLSX format can be used to bulk load instances of device/cucm/PhoneSecurityProfile and the JSON format can be used to import instances of device/cucm/PhoneSecurityProfile.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/device/cucm/PhoneSecurityProfile/[pkid]/ | hierarchy=[hierarchy] | The device/cucm/PhoneSecurityProfile instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/device/cucm/PhoneSecurityProfile/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/cucm/PhoneSecurityProfile. |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Apply | POST | /api/device/cucm/PhoneSecurityProfile/[pkid]/+apply/ | hierarchy=[hierarchy] | If payload required: |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Purge | POST | /api/device/cucm/PhoneSecurityProfile/[pkid]/purge/ | hierarchy=[hierarchy] | If payload required: |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Reset | POST | /api/device/cucm/PhoneSecurityProfile/[pkid]/+reset/ | hierarchy=[hierarchy] | If payload required: |