IOS-XE VoIP
- Overview
- Guides
- Global SIP Configurations
- SIP Dial Peer Configurations
- Call Manager Fallback Configurations
- DSPFARM Profile Configurations
- Num-Exp Configurations
- Gateway Configurations
- Application Configurations
- Unified Communication Configurations
- HTTP Configurations
- SIP User Agent Configurations
- Codec Configurations
- Credentials Configurations
- Media Configurations
- Call Admission Control Configurations
- Gateway Accounting Configurations
- Voice Class Codec Configurations
- Voice Register Configurations
- Operational Data
- Developer Resources
- Community & Support
Unified Communication Configurations
The following operations are allowed in the Unified Communications configuration mode:
| Operations | X-path |
|---|---|
| get, get-config, edit-config | /native/ios-voice:uc |
Select UC Configuration Mode
To enter into the uc configuration mode, follow the x-path provided in the below table.
| Object | X-path |
|---|---|
| voice uc | /native/ios-voice:uc |
Newly Added YANG Models in Release Cisco IOS XE 17.7.1
The following YANG models are supported from Cisco IOS XE 17.7.1:
- uc wsapi
- uc secure-wsapi
Unified Communications Configurations and X-path Details
| Object | Description | X-path | Value | Prerequisites | Remarks |
|---|---|---|---|---|---|
| uc wsapi | To configure Cisco Unified Communications Gateway services. | /native/ios-voice:uc/ios-voice:wsapi |
N/A | N/A | uc wsapi and uc secure-wsapi cannot exist together. |
| wsapi message-exchange max-failures | To configure the maximum number of failed message exchanges between the application and the provider before the provider stops sending messages to the application. | /native/ios-voice:uc/ios-voice:wsapi/ios-voice:message-exchange/ios-voice:max-failures |
Min 1, Max 100 | N/A | Default value is 1. |
| wsapi response-timeout | Response timeout for outbound solicit and notify. | /native/ios-voice:uc/ios-voice:wsapi/ios-voice:response-timeout |
Min 1, Max 300 | N/A | N/A |
| wsapi source-address | Source address in IP address or hostname. | /native/ios-voice:uc/ios-voice:wsapi/ios-voice:source-address |
String | N/A | N/A |
| wsapi probing max-failures | To configure the maximum number of failed probing messages before the voice gateway unregisters the application. | /native/ios-voice:uc/ios-voice:secure-wsapi/ios-voice:probing/ios-voice:max-failures |
Min 1, Max 5 | N/A | Default is 3. |
| wsapi probing interval keepalive | To configure the interval between probing messages. | /native/ios-voice:uc/ios-voice:secure-wsapi/ios-voice:probing/ios-voice:interval/ios-voice:keepalive |
Min 1, Max 255 | N/A | Default is 120. |
| wsapi probing interval negative | To configure the interval between negative probing messages. | /native/ios-voice:uc/ios-voice:secure-wsapi/ios-voice:probing/ios-voice:interval/ios-voice:negative |
Min 1, Max 20 | N/A | Default is 5. |
| wsapi provider xcc | To configure the XCC provider. | /native/ios-voice:uc/ios-voice:wsapi/ios-voice:provider/ios-voice:xcc |
N/A | N/A | N/A |
| wsapi provider xcc remote-url | To specify the URL that the application uses to communicate with XCC provider. | /native/ios-voice:uc/ios-voice:wsapi/ios-voice:provider/ios-voice:xcc/ios-voice:remote-url |
String | N/A | N/A |
| wsapi provider xcc shutdown | To shutdown the XCC provider. | /native/ios-voice:uc/ios-voice:wsapi/ios-voice:provider/ios-voice:xcc/ios-voice:shutdown |
true, false | N/A | Default value is false. |
| wsapi provider xmf | To configure the XMF provider. | /native/ios-voice:uc/ios-voice:wsapi/ios-voice:provider/ios-voice:xmf |
N/A | N/A | N/A |
| wsapi provider xmf remote-url url-index | To specify upto 32 URLs that the application can use to communicate with XMF provider. | /native/ios-voice:uc/ios-voice:wsapi/ios-voice:provider/ios-voice:xmf/ios-voice:remote-url/ios-voice:url-index |
Min 1, Max 32 | N/A | N/A |
| wsapi provider xmf remote-url url-string | To specify the URL that the application uses to communicate with XMF provider. | /native/ios-voice:uc/ios-voice:wsapi/ios-voice:provider/ios-voice:xmf/ios-voice:remote-url/ios-voice:url-string |
String | N/A | N/A |
| wsapi provider xmf shutdown | To shutdown the XMF provider. | /native/ios-voice:uc/ios-voice:wsapi/ios-voice:provider/ios-voice:xmf/ios-voice:remote-url/ios-voice:url-string |
true or false. | N/A | Default is false. |
| wsapi provider xcdr | To configure the XCDR provider. | /native/ios-voice:uc/ios-voice:wsapi/ios-voice:provider/ios-voice:xcdr |
N/A | N/A | N/A |
| wsapi provider xcdr remote-url url-index | To specify upto 8 URLs that the application can use to communicate with the XCDR provider. | /native/ios-voice:uc/ios-voice:wsapi/ios-voice:provider/ios-voice:xcdr/ios-voice:remote-url/ios-voice:url-index |
Min 1, Max 8 | N/A | N/A |
| wsapi provider xcdr remote-url url-string | To specify the URL that the application uses to communicate with the XCDR provider. | /native/ios-voice:uc/ios-voice:wsapi/ios-voice:provider/ios-voice:xcdr/ios-voice:remote-url/ios-voice:url-string |
String | N/A | N/A |
| wsapi provider xcdr shutdown | To shut down the XCDR provider. | /native/ios-voice:uc/ios-voice:wsapi/ios-voice:provider/ios-voice:xcdr/ios-voice:shutdown |
true or false | N/A | Default is false. |
| wsapi provider xsvc | To configure the XSVC provider. | /native/ios-voice:uc/ios-voice:wsapi/ios-voice:provider/ios-voice:xsvc |
N/A | N/A | N/A |
| wsapi provider xsvc remote-url url-index | To specify upto 8 URLs that the application can use to communicate with the XSVC provider. | /native/ios-voice:uc/ios-voice:wsapi/ios-voice:provider/ios-voice:xsvc/ios-voice:remote-url/ios-voice:url-index |
Min 1, Max 8 | N/A | N/A |
| wsapi provider xsvc remote-url url-string | To specify the URL that the application uses to communicate with the XSVC provider. | /native/ios-voice:uc/ios-voice:wsapi/ios-voice:provider/ios-voice:xsvc/ios-voice:remote-url/ios-voice:url-string |
String | N/A | N/A |
| wsapi provider xsvc shutdown | To shut down the XSVC provider. | /native/ios-voice:uc/ios-voice:wsapi/ios-voice:provider/ios-voice:xsvc/ios-voice:shutdown |
true or false | N/A | Default is false. |
| uc secure-wsapi | To configure secure Cisco Unified Communications Gateway services. | /native/ios-voice:uc/ios-voice:secure-wsapi |
N/A | N/A | N/A |
| secure-wsapi message-exchange max-failures | To configure the maximum number of failed message exchanges between the application and the provider before the provider stops sending messages to the application. | /native/ios-voice:uc/ios-voice:secure-wsapi/ios-voice:message-exchange/ios-voice:max-failures |
Min 1, Max 100 | N/A | Default is 1. |
| secure-wsapi response-timeout | Response timeout for outbound solicit and notify. | /native/ios-voice:uc/ios-voice:secure-wsapi/ios-voice:response-timeout |
Min 1, Max 300 | N/A | N/A |
| secure-wsapi source address | Source address in IP address or hostname. | /native/ios-voice:uc/ios-voice:secure-wsapi/ios-voice:source-address |
String | N/A | N/A |
| secure-wsapi probing max-failures | To configure the maximum number of failed probing messages before the voice gateway unregisters the application. | /native/ios-voice:uc/ios-voice:secure-wsapi/ios-voice:probing/ios-voice:max-failures |
Min 1, Max 5 | N/A | Default is 3. |
| secure-wsapi probing interval keepalive | To configure the interval between probing messages. | /native/ios-voice:uc/ios-voice:secure-wsapi/ios-voice:probing/ios-voice:interval/ios-voice:keepalive |
Min 1, Max 255 | N/A | Default is 120. |
| secure-wsapi probing negative | To configure the interval between negative probing messages. | /native/ios-voice:uc/ios-voice:secure-wsapi/ios-voice:probing/ios-voice:interval/ios-voice:negative |
Min 1, Max 20 | N/A | Default is 5. |
| secure-wsapi provider xcc | To configure the XCC provider. | /native/ios-voice:uc/ios-voice:secure-wsapi/ios-voice:provider/ios-voice:xcc |
N/A | N/A | N/A |
| secure-wsapi provider xcc remote-url | To specify the URL that the application uses to communicate with XCC provider. | /native/ios-voice:uc/ios-voice:secure-wsapi/ios-voice:provider/ios-voice:xcc/ios-voice:remote-url |
String | N/A | N/A |
| secure-wsapi provider xcc shutdown | To shutdown the XCC provider. | /native/ios-voice:uc/ios-voice:secure-wsapi/ios-voice:provider/ios-voice:xcc/ios-voice:shutdown |
N/A | N/A | N/A |
| secure-wsapi provider xsvc | To configure the XSVC provider. | /native/ios-voice:uc/ios-voice:secure-wsapi/ios-voice:provider/ios-voice:xsvc |
N/A | N/A | N/A |
| secure-wsapi provider xsvc remote-url url-index | To specify the URL index that applications can use to communicate with the XSVC provider. | /native/ios-voice:uc/ios-voice:secure-wsapi/ios-voice:provider/ios-voice:xsvc/ios-voice:remote-url/ios-voice:url-index |
1 | N/A | N/A |
| secure-wsapi provider xsvc remote-url url-string | To specify URLs that applications can use to communicate with the XSVC provider. | /native/ios-voice:uc/ios-voice:secure-wsapi/ios-voice:provider/ios-voice:xsvc/ios-voice:remote-url/ios-voice:url-string |
String in the format https://[ipv4_address][:port][/path] | N/A | N/A |
| secure-wsapi provider xsvc shutdown | To activate or deactivate the XSVC provider. | /native/ios-voice:uc/ios-voice:secure-wsapi/ios-voice:provider/ios-voice:xsvc/ios-voice:shutdown |
true, false | N/A | Default value is false. |
Examples: Unified Communications Configurations
Requesting 'EditConfig' Sending:
Code Snippet
Copy<nc:rpc xmlns:nc="urn:ietf:params:xml:ns:netconf:base:1.0" message-id="urn:uuid:207ae7bf-7304-46dd-adb4-0636c902dfbf">
196: <nc:edit-config>
197: <nc:target>
198: <nc:running/>
199: </nc:target>
200: <nc:config>
201: <native xmlns="http://cisco.com/ns/yang/Cisco-IOS-XE-native">
202: <uc xmlns="http://cisco.com/ns/yang/Cisco-IOS-XE-voice">
203: <wsapi>
204: <message-exchange>
205: <max-failures nc:operation="create">10</max-failures>
206: </message-exchange>
207: <response-timeout nc:operation="create">1</response-timeout>
208: <source-address nc:operation="create">10.64.86.249</source-address>
209: <probing>
210: <max-failures nc:operation="create">1</max-failures>
211: <interval>
212: <keepalive nc:operation="create">10</keepalive>
213: <negative nc:operation="create">10</negative>
214: </interval>
215: </probing>
216: <provider>
217: <xcc>
218: <remote-url nc:operation="create">https://10.64.86.134:7099/xcc</remote-url>
219: </xcc>
220: </provider>
221: </wsapi>
222: </uc>
223: </native>
224: </nc:config>
225: </nc:edit-config>
226: </nc:rpc>
Received message from host
Code Snippet
Copy<nc:rpc xmlns:nc="urn:ietf:params:xml:ns:netconf:base:1.0" message-id="urn:uuid:39ab74aa-937f-46cf-bda8-238c51712c1c">
236: <nc:unlock>
237: <nc:target>
238: <nc:running/>
239: </nc:target>
240: </nc:unlock>
241: </nc:rpc>