Jump to

• Request
• Response

Retrieve the config element: SD.media-manager

get

https://cloud-native-SBC-IP/config/v1/sd/media-manager

Retrieve the config element: SD.media-manager

Request

Query Parameters

• revision-id: string
  Integer value of saved revision, or 'latest', 'active' to show the running config, or 'staging' to show complete configuration to be activated

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

return config element: MediaRouter

Body ()

Root Schema : schema

Type: object

configure media policy, attributes, and settings

Show Source

• _elementKey: string
  Read Only: true

  Identifier for the element or sub-element
• acl-monitor-window: integer (int64)
  Minimum Value: 5

  Maximum Value: 3600

  Period in seconds to monitor acl drop counts used to determine if an apAclDropOverThresholdTrap trap is sent from the system
• algd-log-level: string
  Allowed Values: [ "EMERGENCY", "CRITICAL", "MAJOR", "MINOR", "WARNING", "NOTICE", "INFO", "TRACE", "DEBUG", "DETAIL" ]
• anonymous-sdp: boolean
  enable username and session name fields in SDP
• app-signaling-bandwidth: integer (int64)
  Minimum Value: 0

  Maximum Value: 100

  max percentage of signaling bandwidth that can be used for registration [MGCP-RSIP] msgs
• arp-critical-threshold: integer (int64)
  Minimum Value: 0

  Maximum Value: 100

  Set the percentage of ARP bandwidth that triggers a critical alarm for this threshold.Set the value to zero to disarm this threshold for alarm
• arp-major-threshold: integer (int64)
  Minimum Value: 0

  Maximum Value: 100

  Set the percentage of ARP bandwidth that triggers a major alarm for this threshold.Set the value to zero to disarm this threshold for alarm
• arp-minor-threshold: integer (int64)
  Minimum Value: 0

  Maximum Value: 100

  Set the percentage of ARP bandwidth that triggers a minor alarm for this threshold.Set the value to zero to disarm this threshold for alarm
• dos-guard-window: integer (int64)
  Minimum Value: 1

  Maximum Value: 30

  Period in seconds to monitor DOS counters
• dynamic-trusted-drop-threshold: integer (int64)
  Minimum Value: 0

  Maximum Value: 100

  percentage of drop count threshold for dynamic trusted hosts
• flow-time-limit: integer (int64)
  Minimum Value: 1

  Maximum Value: 2073600

  time limit for a flow (seconds)
• fragment-drop-threshold: integer (int64)
  Minimum Value: 0

  Maximum Value: 100

  percentage of drop count threshold for fragment hosts
• hnt-rtcp: boolean
  RTCP for Hosted NAT Traversal
• initial-guard-timer: integer (int64)
  Minimum Value: 1

  Maximum Value: 86400

  initial flow guard timer (seconds)
• latching: boolean
  latching onto source address of 1st packet
• max-arp-rate: integer (int64)
  Minimum Value: 0

  Maximum Value: 100

  Maximum percentage of bandwidth to be used by ARP
• max-signaling-packets: integer (int64)
  Minimum Value: 0

  Maximum Value: 4294967295

  Maximum signaling packets per second, set to 0 will use default limit
• max-untrusted-signaling: integer (int64)
  Minimum Value: 0

  Maximum Value: 100

  Maximum percentage of signaling bandwidth that can be used by untrusted hosts
• mbcd-log-level: string
  Allowed Values: [ "EMERGENCY", "CRITICAL", "MAJOR", "MINOR", "WARNING", "NOTICE", "INFO", "TRACE", "DEBUG", "DETAIL" ]
• media-policing: boolean
  enable media policing
• media-supervision-traps: boolean
  Media Supervision Timer expiration traps
• min-untrusted-signaling: integer (int64)
  Minimum Value: 0

  Maximum Value: 100

  Minimum percentage of signaling bandwidth guaranteed for untrusted hosts
• options: string
  optional features/parameters
• red-flow-port: integer (int32)
  Minimum Value: 0

  Maximum Value: 65535

  port to listen for redundancy flow sync messages on
• red-max-trans: integer (int64)
  Minimum Value: 0

  Maximum Value: 50000

  max number of redundancy sync transactions to keep on active
• red-mgcp-port: integer (int32)
  Minimum Value: 0

  Maximum Value: 65535

  port to listen for redundancy mgcp sync messages on
• red-sync-comp-time: integer (int64)
  Minimum Value: 0

  Maximum Value: 4294967295

  once complete redundancy sync has occurred, timeout for subsequent sync requests
• red-sync-start-time: integer (int64)
  Minimum Value: 0

  Maximum Value: 4294967295

  timeout for checking transition from standby to active, therefore need to start sending redundancy sync requests
• rfc2833-end-pkts-only-for-non-sig: boolean
  enable sending only end packet for non-signaled events
• rtcp-rate-limit: integer (int64)
  Minimum Value: 0

  Maximum Value: 125000000

  rtcp rate limit in bytes per second
• state: boolean
  administrative state
• subsq-guard-timer: integer (int64)
  Minimum Value: 1

  Maximum Value: 86400

  subsequent flow guard timer (seconds)
• syslog-on-call-reject: boolean
  enable syslogs on SIP Call rejections
• tcp-flow-time-limit: integer (int64)
  Minimum Value: 1

  Maximum Value: 2073600

  time limit for a TCP flow (seconds)
• tcp-initial-guard-timer: integer (int64)
  Minimum Value: 1

  Maximum Value: 86400

  initial TCP flow init timer (seconds)
• tcp-number-of-ports-per-flow: integer (int64)
  Minimum Value: 2

  Maximum Value: 5

  number of TCP ports per flow
• tcp-subsq-guard-timer: integer (int64)
  Minimum Value: 1

  Maximum Value: 86400

  subsequent TCP flow guard timer (seconds)
• tolerance-window: integer (int64)
  Minimum Value: 0

  Maximum Value: 4294967295

  tolerance-window size (seconds) to measure host access limits
• translate-non-rfc2833-event: boolean
  Accept UII/INFO Events for IWF even though RFC2833 preferred
• trusted-critical-threshold: integer (int64)
  Minimum Value: 0

  Maximum Value: 100

  Set the percentage of trusted bandwidth that triggers a critical alarm for this threshold.Set the value to zero to disarm this threshold for alarm
• trusted-drop-threshold: integer (int64)
  Minimum Value: 0

  Maximum Value: 100

  The percentage of dropped packets out of total trusted host traffic that needs to be exceeded for the system to send an apAclDropOverThresholdTrap trap
• trusted-major-threshold: integer (int64)
  Minimum Value: 0

  Maximum Value: 100

  Set the percentage of trusted bandwidth that triggers a major alarm for this threshold.Set the value to zero to disarm this threshold for alarm
• trusted-minor-threshold: integer (int64)
  Minimum Value: 0

  Maximum Value: 100

  Set the percentage of trusted bandwidth that triggers a minor alarm for this threshold.Set the value to zero to disarm this threshold for alarm
• untrusted-critical-threshold: integer (int64)
  Minimum Value: 0

  Maximum Value: 100

  Set the percentage of untrusted bandwidth that triggers a critical alarm for this threshold.Set the value to zero to disarm this threshold for alarm
• untrusted-drop-threshold: integer (int64)
  Minimum Value: 0

  Maximum Value: 100

  The percentage of dropped packets out of total untrusted host traffic that needs to be exceeded for the system to send an apAclDropOverThresholdTrap trap
• untrusted-major-threshold: integer (int64)
  Minimum Value: 0

  Maximum Value: 100

  Set the percentage of untrusted bandwidth that triggers a major alarm for this threshold.Set the value to zero to disarm this threshold for alarm
• untrusted-minor-threshold: integer (int64)
  Minimum Value: 0

  Maximum Value: 100

  Set the percentage of untrusted bandwidth that triggers a minor alarm for this threshold.Set the value to zero to disarm this threshold for alarm

{
    "properties":{
        "state":{
            "description":"administrative state",
            "type":"boolean"
        },
        "latching":{
            "description":"latching onto source address of 1st packet",
            "type":"boolean"
        },
        "flow-time-limit":{
            "description":"time limit for a flow (seconds)",
            "format":"int64",
            "maximum":2073600,
            "minimum":1,
            "type":"integer"
        },
        "initial-guard-timer":{
            "description":"initial flow guard timer (seconds)",
            "format":"int64",
            "maximum":86400,
            "minimum":1,
            "type":"integer"
        },
        "subsq-guard-timer":{
            "description":"subsequent flow guard timer (seconds)",
            "format":"int64",
            "maximum":86400,
            "minimum":1,
            "type":"integer"
        },
        "tcp-flow-time-limit":{
            "description":"time limit for a TCP flow (seconds)",
            "format":"int64",
            "maximum":2073600,
            "minimum":1,
            "type":"integer"
        },
        "tcp-initial-guard-timer":{
            "description":"initial TCP flow init timer (seconds)",
            "format":"int64",
            "maximum":86400,
            "minimum":1,
            "type":"integer"
        },
        "tcp-subsq-guard-timer":{
            "description":"subsequent TCP flow guard timer (seconds)",
            "format":"int64",
            "maximum":86400,
            "minimum":1,
            "type":"integer"
        },
        "tcp-number-of-ports-per-flow":{
            "description":"number of TCP ports per flow",
            "format":"int64",
            "maximum":5,
            "minimum":2,
            "type":"integer"
        },
        "hnt-rtcp":{
            "description":"RTCP for Hosted NAT Traversal",
            "type":"boolean"
        },
        "algd-log-level":{
            "$ref":"#/components/schemas/SlogLevelConstraintEnum"
        },
        "mbcd-log-level":{
            "$ref":"#/components/schemas/SlogLevelConstraintEnum"
        },
        "options":{
            "description":"optional features/parameters",
            "type":"string"
        },
        "red-flow-port":{
            "description":"port to listen for redundancy flow sync messages on",
            "format":"int32",
            "maximum":65535,
            "minimum":0,
            "type":"integer"
        },
        "red-mgcp-port":{
            "description":"port to listen for redundancy mgcp sync messages on",
            "format":"int32",
            "maximum":65535,
            "minimum":0,
            "type":"integer"
        },
        "red-max-trans":{
            "description":"max number of redundancy sync transactions to keep on active",
            "format":"int64",
            "maximum":50000,
            "minimum":0,
            "type":"integer"
        },
        "red-sync-start-time":{
            "description":"timeout for checking transition from standby to active, therefore need to start sending redundancy sync requests",
            "format":"int64",
            "maximum":"4294967295",
            "minimum":0,
            "type":"integer"
        },
        "red-sync-comp-time":{
            "description":"once complete redundancy sync has occurred, timeout for subsequent sync requests",
            "format":"int64",
            "maximum":"4294967295",
            "minimum":0,
            "type":"integer"
        },
        "media-policing":{
            "description":"enable media policing",
            "type":"boolean"
        },
        "max-arp-rate":{
            "description":"Maximum percentage of bandwidth to be used by ARP",
            "format":"int64",
            "maximum":100,
            "minimum":0,
            "type":"integer"
        },
        "max-signaling-packets":{
            "description":"Maximum signaling packets per second, set to 0 will use default limit",
            "format":"int64",
            "maximum":"4294967295",
            "minimum":0,
            "type":"integer"
        },
        "max-untrusted-signaling":{
            "description":"Maximum percentage of signaling bandwidth that can be used by untrusted hosts",
            "format":"int64",
            "maximum":100,
            "minimum":0,
            "type":"integer"
        },
        "min-untrusted-signaling":{
            "description":"Minimum percentage of signaling bandwidth guaranteed for untrusted hosts",
            "format":"int64",
            "maximum":100,
            "minimum":0,
            "type":"integer"
        },
        "dos-guard-window":{
            "description":"Period in seconds to monitor DOS counters",
            "format":"int64",
            "maximum":30,
            "minimum":1,
            "type":"integer"
        },
        "untrusted-minor-threshold":{
            "description":"Set the percentage of untrusted bandwidth that triggers a minor alarm for this threshold.Set the value to zero to disarm this threshold for alarm",
            "format":"int64",
            "maximum":100,
            "minimum":0,
            "type":"integer"
        },
        "untrusted-major-threshold":{
            "description":"Set the percentage of untrusted bandwidth that triggers a major alarm for this threshold.Set the value to zero to disarm this threshold for alarm",
            "format":"int64",
            "maximum":100,
            "minimum":0,
            "type":"integer"
        },
        "untrusted-critical-threshold":{
            "description":"Set the percentage of untrusted bandwidth that triggers a critical alarm for this threshold.Set the value to zero to disarm this threshold for alarm",
            "format":"int64",
            "maximum":100,
            "minimum":0,
            "type":"integer"
        },
        "trusted-minor-threshold":{
            "description":"Set the percentage of trusted bandwidth that triggers a minor alarm for this threshold.Set the value to zero to disarm this threshold for alarm",
            "format":"int64",
            "maximum":100,
            "minimum":0,
            "type":"integer"
        },
        "trusted-major-threshold":{
            "description":"Set the percentage of trusted bandwidth that triggers a major alarm for this threshold.Set the value to zero to disarm this threshold for alarm",
            "format":"int64",
            "maximum":100,
            "minimum":0,
            "type":"integer"
        },
        "trusted-critical-threshold":{
            "description":"Set the percentage of trusted bandwidth that triggers a critical alarm for this threshold.Set the value to zero to disarm this threshold for alarm",
            "format":"int64",
            "maximum":100,
            "minimum":0,
            "type":"integer"
        },
        "arp-minor-threshold":{
            "description":"Set the percentage of ARP bandwidth that triggers a minor alarm for this threshold.Set the value to zero to disarm this threshold for alarm",
            "format":"int64",
            "maximum":100,
            "minimum":0,
            "type":"integer"
        },
        "arp-major-threshold":{
            "description":"Set the percentage of ARP bandwidth that triggers a major alarm for this threshold.Set the value to zero to disarm this threshold for alarm",
            "format":"int64",
            "maximum":100,
            "minimum":0,
            "type":"integer"
        },
        "arp-critical-threshold":{
            "description":"Set the percentage of ARP bandwidth that triggers a critical alarm for this threshold.Set the value to zero to disarm this threshold for alarm",
            "format":"int64",
            "maximum":100,
            "minimum":0,
            "type":"integer"
        },
        "app-signaling-bandwidth":{
            "description":"max percentage of signaling bandwidth that can be used for registration [MGCP-RSIP] msgs",
            "format":"int64",
            "maximum":100,
            "minimum":0,
            "type":"integer"
        },
        "tolerance-window":{
            "description":"tolerance-window size (seconds) to measure host access limits",
            "format":"int64",
            "maximum":"4294967295",
            "minimum":0,
            "type":"integer"
        },
        "untrusted-drop-threshold":{
            "description":"The percentage of dropped packets out of total untrusted host traffic that needs to be exceeded for the system to send an apAclDropOverThresholdTrap trap",
            "format":"int64",
            "maximum":100,
            "minimum":0,
            "type":"integer"
        },
        "trusted-drop-threshold":{
            "description":"The percentage of dropped packets out of total trusted host traffic that needs to be exceeded for the system to send an apAclDropOverThresholdTrap trap",
            "format":"int64",
            "maximum":100,
            "minimum":0,
            "type":"integer"
        },
        "dynamic-trusted-drop-threshold":{
            "description":"percentage of drop count threshold for dynamic trusted hosts",
            "format":"int64",
            "maximum":100,
            "minimum":0,
            "type":"integer"
        },
        "fragment-drop-threshold":{
            "description":"percentage of drop count threshold for fragment hosts",
            "format":"int64",
            "maximum":100,
            "minimum":0,
            "type":"integer"
        },
        "acl-monitor-window":{
            "description":"Period in seconds to monitor acl drop counts used to determine if an apAclDropOverThresholdTrap trap is sent from the system",
            "format":"int64",
            "maximum":3600,
            "minimum":5,
            "type":"integer"
        },
        "rtcp-rate-limit":{
            "description":"rtcp rate limit in bytes per second",
            "format":"int64",
            "maximum":125000000,
            "minimum":0,
            "type":"integer"
        },
        "anonymous-sdp":{
            "description":"enable username and session name fields in SDP",
            "type":"boolean"
        },
        "rfc2833-end-pkts-only-for-non-sig":{
            "description":"enable sending only end packet for non-signaled events",
            "type":"boolean"
        },
        "translate-non-rfc2833-event":{
            "description":"Accept UII/INFO Events for IWF even though RFC2833 preferred",
            "type":"boolean"
        },
        "media-supervision-traps":{
            "description":"Media Supervision Timer expiration traps",
            "type":"boolean"
        },
        "syslog-on-call-reject":{
            "description":"enable syslogs on SIP Call rejections",
            "type":"boolean"
        },
        "_elementKey":{
            "description":"Identifier for the element or sub-element",
            "readOnly":true,
            "type":"string"
        }
    },
    "description":"configure media policy, attributes, and settings",
    "type":"object"
}

404 Response

Not Found

Body ()

Root Schema : ApiValidationError

Type: object

Show Source

• _elementKey: string
  Read Only: true

  Identifier for the element or sub-element
• code: string
• errors: array errors
• message: string
• timestamp: string

{
    "properties":{
        "timestamp":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "message":{
            "type":"string"
        },
        "errors":{
            "items":{
                "$ref":"#/components/schemas/Errors"
            },
            "type":"array"
        },
        "_elementKey":{
            "description":"Identifier for the element or sub-element",
            "readOnly":true,
            "type":"string"
        }
    },
    "type":"object"
}

Nested Schema : errors

Type: array

Show Source

• Array of: object Errors

{
    "items":{
        "$ref":"#/components/schemas/Errors"
    },
    "type":"array"
}

Nested Schema : Errors

Type: object

Show Source

• _elementKey: string
  Read Only: true

  Identifier for the element or sub-element
• attribute: string
• code: string
• message: string
• type: string
  Allowed Values: [ "error", "fatal", "warn" ]

{
    "properties":{
        "attribute":{
            "type":"string"
        },
        "type":{
            "$ref":"#/components/schemas/TypeEnum"
        },
        "message":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "_elementKey":{
            "description":"Identifier for the element or sub-element",
            "readOnly":true,
            "type":"string"
        }
    },
    "type":"object"
}

Back to Top