Child pages
  • Shared Appearance Agent (SAA)
Skip to end of metadata
Go to start of metadata

View SAA settings

Available in 14 starting with 14.10

Resource URI: /saa/settings

Default Resource Properties:

The resource is represented by the following properties when the GET request is performed:

Property

Description





Specific Response Codes: N/A

HTTP Method: GET

Retrieves a list with all the SAA settings in the system.

Example: XML format

<Settings>

<Setting>

<path>Uniteme-saa-config/server-udp-port</path>

<type>integer</type>

<value>5170</value>

<defaultValue>5170</defaultValue>

<label>UDP Port</label>

</Setting>

<Setting>

<path>Uniteme-saa-config/server-tcp-port</path>

<type>integer</type>

<value>5170</value>

<defaultValue>5170</defaultValue>

<label>TCP Port</label>

</Setting>

<Setting>

<path>Uniteme-saa-config/log-level</path>

<type>enum</type>

<options>

<entry>

<key>3</key>

<value>ERR</value>

</entry>

<entry>

<key>2</key>

<value>CRIT</value>

</entry>

<entry>

<key>1</key>

<value>ALERT</value>

</entry>

<entry>

<key>0</key>

<value>EMERG</value>

</entry>

<entry>

<key>7</key>

<value>DEBUG</value>

</entry>

<entry>

<key>6</key>

<value>INFO</value>

</entry>

<entry>

<key>5</key>

<value>NOTICE</value>

</entry>

<entry>

<key>4</key>

<value>WARNING</value>

</entry>

</options>

<value>5</value>

<defaultValue>5</defaultValue>

<label>Log Level</label>

</Setting>

<Setting>

<path>Uniteme-saa-config/server-min-expires</path>

<type>integer</type>

<value>300</value>

<defaultValue>300</defaultValue>

<label>Minimum Expires</label>

<description>Minimum number of seconds after which the subscribe expires</description>

</Setting>

<Setting>

<path>Uniteme-saa-config/server-default-expires</path>

<type>integer</type>

<value>3600</value>

<defaultValue>3600</defaultValue>

<label>Default Expires</label>

<description>Default number of seconds after which the subscribe expires</description>

</Setting>

<Setting>

<path>Uniteme-saa-config/server-max-expires</path>

<type>integer</type>

<value>86400</value>

<defaultValue>86400</defaultValue>

<label>Maximum Expires</label>

<description>Maximum number of seconds after which the subscribe expires</description>

</Setting>

<Setting>

<path>Uniteme-saa-config/notification-interval</path>

<type>integer</type>

<value>1000</value>

<defaultValue>1000</defaultValue>

<label>Notification Interval</label>

<description>The interval in milliseconds used by SAA to push partial notifications with status updates to subscribers</description>

</Setting>

<Setting>

<path>Uniteme-saa-config/enable-stack-logs</path>

<type>boolean</type>

<value>false</value>

<defaultValue>false</defaultValue>

<label>Enable Stack Logs</label>

<description>If checked SAA will save in the log file also the logs generated by the internal stack</description>

</Setting>

<Setting>

<path>Uniteme-saa-config/max-udp-notify-body-size</path>

<type>integer</type>

<value>64512</value>

<defaultValue>64512</defaultValue>

<label>Maximum UDP NOTIFY Body Size</label>

<description>Maximum body size for a NOTIFY message sent for a subscription done over UDP. By default this is set to 63Kb assuming 1k for SIP headers.</description>

</Setting>

<Setting>

<path>Uniteme-saa-config/max-tcp-notify-body-size</path>

<type>integer</type>

<value>10485760</value>

<defaultValue>10485760</defaultValue>

<label>Maximum TCP NOTIFY Body Size</label>

<description>Maximum body size for a NOTIFY message sent for a subscription done over TCP. By default this is set to 10Mb.</description>

</Setting>

<Setting>

<path>Uniteme-saa-config/max-notify-resend-interval-sec</path>

<type>integer</type>

<value>300</value>

<defaultValue>300</defaultValue>

<label>Maximum notify resend interval</label>

<description>Maximum value of the interval in seconds used to resend rejected notifies. By default this is set to 300 seconds. <br/>It must be greater than Notification Interval.</description>

</Setting>

<Setting>

<path>Uniteme-saa-config/max-instances-per-line</path>

<type>integer</type>

<value>63</value>

<defaultValue>63</defaultValue>

<label>Maximum appearances per line</label>

<description>Maximum number of appearances for a shared line.</description>

</Setting>

<Setting>

<path>Uniteme-saa-config/max-appearances-per-line</path>

<type>integer</type>

<value>24</value>

<defaultValue>24</defaultValue>

<label>Maximum instances per line</label>

<description>Maximum number of instances for a shared line.</description>

</Setting>

<Setting>

<path>Uniteme-saa-config/subscription-restart-interval</path>

<type>integer</type>

<value>86400</value>

<defaultValue>86400</defaultValue>

<label>Subscription restart interval</label>

<description>Time in seconds after which SAA client subscriptions are restarted.</description>

</Setting>

<Setting>

<path>resource-limits/fd-soft</path>

<type>integer</type>

<value>32768</value>

<defaultValue>32768</defaultValue>

<label>FD Soft</label>

<description>FD Soft resource limit</description>

</Setting>

<Setting>

<path>resource-limits/fd-hard</path>

<type>integer</type>

<value>65536</value>

<defaultValue>65536</defaultValue>

<label>FD Hard</label>

<description>FD Hard resource limit</description>

</Setting>

<Setting>

<path>resource-limits/core-enabled</path>

<type>boolean</type>

<value>false</value>

<defaultValue>false</defaultValue>

<label>Core Enabled</label>

<description>Core Enabled resource limit</description>

</Setting>

</Settings>

settings: [17]

0: {

path: "Uniteme-saa-config/server-udp-port"

type: "integer"

options: null

value: "5170"

defaultValue: "5170"

label: "UDP Port"

description: null

}-

1: {

path: "Uniteme-saa-config/server-tcp-port"

type: "integer"

options: null

value: "5170"

defaultValue: "5170"

label: "TCP Port"

description: null

}-

2: {

path: "Uniteme-saa-config/log-level"

type: "enum"

options: {

0: "EMERG"

1: "ALERT"

2: "CRIT"

3: "ERR"

4: "WARNING"

5: "NOTICE"

6: "INFO"

7: "DEBUG"

}-

value: "5"

defaultValue: "5"

label: "Log Level"

description: null

}-

3: {

path: "Uniteme-saa-config/server-min-expires"

type: "integer"

options: null

value: "300"

defaultValue: "300"

label: "Minimum Expires"

description: "Minimum number of seconds after which the subscribe expires"

}-

4: {

path: "Uniteme-saa-config/server-default-expires"

type: "integer"

options: null

value: "3600"

defaultValue: "3600"

label: "Default Expires"

description: "Default number of seconds after which the subscribe expires"

}-

5: {

path: "Uniteme-saa-config/server-max-expires"

type: "integer"

options: null

value: "86400"

defaultValue: "86400"

label: "Maximum Expires"

description: "Maximum number of seconds after which the subscribe expires"

}-

6: {

path: "Uniteme-saa-config/notification-interval"

type: "integer"

options: null

value: "1000"

defaultValue: "1000"

label: "Notification Interval"

description: "The interval in milliseconds used by SAA to push partial notifications with status updates to subscribers"

}-

7: {

path: "Uniteme-saa-config/enable-stack-logs"

type: "boolean"

options: null

value: "false"

defaultValue: "false"

label: "Enable Stack Logs"

description: "If checked SAA will save in the log file also the logs generated by the internal stack"

}-

8: {

path: "Uniteme-saa-config/max-udp-notify-body-size"

type: "integer"

options: null

value: "64512"

defaultValue: "64512"

label: "Maximum UDP NOTIFY Body Size"

description: "Maximum body size for a NOTIFY message sent for a subscription done over UDP. By default this is set to 63Kb assuming 1k for SIP headers."

}-

9: {

path: "Uniteme-saa-config/max-tcp-notify-body-size"

type: "integer"

options: null

value: "10485760"

defaultValue: "10485760"

label: "Maximum TCP NOTIFY Body Size"

description: "Maximum body size for a NOTIFY message sent for a subscription done over TCP. By default this is set to 10Mb."

}-

10: {

path: "Uniteme-saa-config/max-notify-resend-interval-sec"

type: "integer"

options: null

value: "300"

defaultValue: "300"

label: "Maximum notify resend interval"

description: "Maximum value of the interval in seconds used to resend rejected notifies. By default this is set to 300 seconds. <br/>It must be greater than Notification Interval."

}-

11: {

path: "Uniteme-saa-config/max-instances-per-line"

type: "integer"

options: null

value: "63"

defaultValue: "63"

label: "Maximum appearances per line"

description: "Maximum number of appearances for a shared line."

}-

12: {

path: "Uniteme-saa-config/max-appearances-per-line"

type: "integer"

options: null

value: "24"

defaultValue: "24"

label: "Maximum instances per line"

description: "Maximum number of instances for a shared line."

}-

13: {

path: "Uniteme-saa-config/subscription-restart-interval"

type: "integer"

options: null

value: "86400"

defaultValue: "86400"

label: "Subscription restart interval"

description: "Time in seconds after which SAA client subscriptions are restarted."

}-

14: {

path: "resource-limits/fd-soft"

type: "integer"

options: null

value: "32768"

defaultValue: "32768"

label: "FD Soft"

description: "FD Soft resource limit"

}-

15: {

path: "resource-limits/fd-hard"

type: "integer"

options: null

value: "65536"

defaultValue: "65536"

label: "FD Hard"

description: "FD Hard resource limit"

}-

16: {

path: "resource-limits/core-enabled"

type: "boolean"

options: null

value: "false"

defaultValue: "false"

label: "Core Enabled"

description: "Core Enabled resource limit"

}-

-

}

JSON format

{

settings: [17]

0: {

path: "Uniteme-saa-config/server-udp-port"

type: "integer"

options: null

value: "5170"

defaultValue: "5170"

label: "UDP Port"

description: null

}-

1: {

path: "Uniteme-saa-config/server-tcp-port"

type: "integer"

options: null

value: "5170"

defaultValue: "5170"

label: "TCP Port"

description: null

}-

2: {

path: "Uniteme-saa-config/log-level"

type: "enum"

options: {

0: "EMERG"

1: "ALERT"

2: "CRIT"

3: "ERR"

4: "WARNING"

5: "NOTICE"

6: "INFO"

7: "DEBUG"

}-

value: "5"

defaultValue: "5"

label: "Log Level"

description: null

}-

3: {

path: "Uniteme-saa-config/server-min-expires"

type: "integer"

options: null

value: "300"

defaultValue: "300"

label: "Minimum Expires"

description: "Minimum number of seconds after which the subscribe expires"

}-

4: {

path: "Uniteme-saa-config/server-default-expires"

type: "integer"

options: null

value: "3600"

defaultValue: "3600"

label: "Default Expires"

description: "Default number of seconds after which the subscribe expires"

}-

5: {

path: "Uniteme-saa-config/server-max-expires"

type: "integer"

options: null

value: "86400"

defaultValue: "86400"

label: "Maximum Expires"

description: "Maximum number of seconds after which the subscribe expires"

}-

6: {

path: "Uniteme-saa-config/notification-interval"

type: "integer"

options: null

value: "1000"

defaultValue: "1000"

label: "Notification Interval"

description: "The interval in milliseconds used by SAA to push partial notifications with status updates to subscribers"

}-

7: {

path: "Uniteme-saa-config/enable-stack-logs"

type: "boolean"

options: null

value: "false"

defaultValue: "false"

label: "Enable Stack Logs"

description: "If checked SAA will save in the log file also the logs generated by the internal stack"

}-

8: {

path: "Uniteme-saa-config/max-udp-notify-body-size"

type: "integer"

options: null

value: "64512"

defaultValue: "64512"

label: "Maximum UDP NOTIFY Body Size"

description: "Maximum body size for a NOTIFY message sent for a subscription done over UDP. By default this is set to 63Kb assuming 1k for SIP headers."

}-

9: {

path: "Uniteme-saa-config/max-tcp-notify-body-size"

type: "integer"

options: null

value: "10485760"

defaultValue: "10485760"

label: "Maximum TCP NOTIFY Body Size"

description: "Maximum body size for a NOTIFY message sent for a subscription done over TCP. By default this is set to 10Mb."

}-

10: {

path: "Uniteme-saa-config/max-notify-resend-interval-sec"

type: "integer"

options: null

value: "300"

defaultValue: "300"

label: "Maximum notify resend interval"

description: "Maximum value of the interval in seconds used to resend rejected notifies. By default this is set to 300 seconds. <br/>It must be greater than Notification Interval."

}-

11: {

path: "Uniteme-saa-config/max-instances-per-line"

type: "integer"

options: null

value: "63"

defaultValue: "63"

label: "Maximum appearances per line"

description: "Maximum number of appearances for a shared line."

}-

12: {

path: "Uniteme-saa-config/max-appearances-per-line"

type: "integer"

options: null

value: "24"

defaultValue: "24"

label: "Maximum instances per line"

description: "Maximum number of instances for a shared line."

}-

13: {

path: "Uniteme-saa-config/subscription-restart-interval"

type: "integer"

options: null

value: "86400"

defaultValue: "86400"

label: "Subscription restart interval"

description: "Time in seconds after which SAA client subscriptions are restarted."

}-

14: {

path: "resource-limits/fd-soft"

type: "integer"

options: null

value: "32768"

defaultValue: "32768"

label: "FD Soft"

description: "FD Soft resource limit"

}-

15: {

path: "resource-limits/fd-hard"

type: "integer"

options: null

value: "65536"

defaultValue: "65536"

label: "FD Hard"

description: "FD Hard resource limit"

}-

16: {

path: "resource-limits/core-enabled"

type: "boolean"

options: null

value: "false"

defaultValue: "false"

label: "Core Enabled"

description: "Core Enabled resource limit"

}-

-

}

Unsupported HTTP Method: PUT, POST, DELETE

View or modify SAA settings

Available in 14 starting with 14.10

Resource URI: /saa/settings/{settingPath

Default Resource Properties:

The resource is represented by the following properties when the GET request is performed:

Property

Description





Specific Response Codes: N/A

HTTP Method: GET

Retrieves SAA options for the setting from the specified path.

Example: XML format

<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>

<Setting>

<path>Uniteme-saa-config/subscription-restart-interval</path>

<type>integer</type>

<value>86400</value>

<defaultValue>86400</defaultValue>

<label>Subscription restart interval</label>

<description>Time in seconds after which SAA client subscriptions are restarted.</description>

</Setting>

JSON format

{

path: "Uniteme-saa-config/subscription-restart-interval"

type: "integer"

options: null

value: "86400"

defaultValue: "86400"

label: "Subscription restart interval"

description: "Time in seconds after which SAA client subscriptions are restarted."

}

HTTP Method: PUT

Modifies SAA options options for the setting from the specified path.

HTTP Method: DELETE

Deletes SAA options options for the setting from the specified path.

Unsupported HTTP Method: POST

  • No labels