Openscape Voice V10 - SOAP Interface Documentation
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Groups Pages
Public Attributes | List of all members
unsp__CreateCACPolicyRequest Struct Reference

Create CAC Policy request. More...

#include <osv-if-doc.h>

Public Attributes

xsd__string OperatorId
 Operator Id. More...
 
xsd__string CACGroupName
 The name of the CAC Group for which this policy is to be created. More...
 
xsd__short CACPolicyType
 Indicates the CAC policy type. More...
 
enum unsp__CACPolicyLimitType CACPolicyLimitType
 Indicates the type of limit specified by the CAC policy. More...
 
xsd__short * CallLimit
 If the CAC policy is to impose a limit on the number of calls, this parameter should be specified. More...
 
xsd__int * BandWidthLimit
 If the CAC policy is to impose a limit on the bandwidth, this parameter should be specified (Kbps or Units). More...
 
enum unsp__CACPolicyOptionFlag * CACPolicyOptionFlag
 
struct unsp__CACPolicyAttributes * CACPolicyAttributes
 Options of the CAC Policy. More...
 
struct unsp__DynamicCACPolicyInfo * DynamicCACPolicyInfo
 Dynamic CAC Policy Info. More...
 
struct
unsp__CACPolicyCodecsAllowed * 
CACPolicyCodecsAllowed
 List of allowed Codecs. More...
 
struct
unsp__CACPolicyVideoCodecsAllowed * 
CACPolicyVideoCodecsAllowed
 List of allowed Video Codecs. More...
 
enum unsp__ProfileLevel * MaximumProfileLevel
 Maximum allowed profile level for H.264. More...
 
xsd__boolean * GenerateAlarm
 Enable or disable generation of alarms when the CACPolicyLimitType exceeds its thresholds. More...
 
xsd__short * AlarmLowThreshold
 Sets the low percentage threshold for the selected policy type. More...
 
xsd__short * AlarmHighThreshold
 Sets the high percentage threshold for the selected policy type. More...
 
xsd__int * MaxVideoCodecBandWidth
 The maximum bandwidth for VP8 and H.264 Codecs. More...
 
bool * Directionalization
 Directionalization. More...
 
bool * USDoDAsac
 US DoD ASAC. More...
 
xsd__short * MaxNumOfInCalls
 Maximum number of Incoming Calls. More...
 
xsd__short * MaxNumOfOutCalls
 Maximum number of Outgoing Calls. More...
 
xsd__int * MaxInBandwidth
 Maximum Incoming Bandwidth (Kbps or Units). More...
 
xsd__int * MaxOutBandwidth
 Maximum Outgoing Bandwidth (Kbps or Units). More...
 
bool * useTIASForBWCalculation
 Use TIAS for BW Calculation. More...
 
xsd__int * transportOverhead
 Transport Overhead. More...
 

Detailed Description

Create CAC Policy request.

Used by unsp__CreateCACPolicy()

Member Data Documentation

xsd__short* unsp__CreateCACPolicyRequest::AlarmHighThreshold

Sets the high percentage threshold for the selected policy type.

When exceeded an alarm will be generated if GenerateAlarm is set to true.
required: false
default value[range]: 80 [10-100]

xsd__short* unsp__CreateCACPolicyRequest::AlarmLowThreshold

Sets the low percentage threshold for the selected policy type.

When exceeded an alarm will be generated if GenerateAlarm is set to true.
required: false
default value[range]: 60 [0-90]

xsd__int* unsp__CreateCACPolicyRequest::BandWidthLimit

If the CAC policy is to impose a limit on the bandwidth, this parameter should be specified (Kbps or Units).


required: false
default value[range]: -1

xsd__string unsp__CreateCACPolicyRequest::CACGroupName

The name of the CAC Group for which this policy is to be created.


required: true

See Also
unsp__CGName
struct unsp__CACPolicyAttributes* unsp__CreateCACPolicyRequest::CACPolicyAttributes

Options of the CAC Policy.


required: false

struct unsp__CACPolicyCodecsAllowed* unsp__CreateCACPolicyRequest::CACPolicyCodecsAllowed

List of allowed Codecs.


required: false

enum unsp__CACPolicyLimitType unsp__CreateCACPolicyRequest::CACPolicyLimitType

Indicates the type of limit specified by the CAC policy.


required: true
default value[range]: NA

enum unsp__CACPolicyOptionFlag* unsp__CreateCACPolicyRequest::CACPolicyOptionFlag
xsd__short unsp__CreateCACPolicyRequest::CACPolicyType

Indicates the CAC policy type.

Policy type is a bitmap, where its bits represent the FaxPolicy, VoicePolicy, and VideoPolicy.

  • 0x0004 (VideoPolicyType)
  • 0x0005 (Voice & VideoPolicyType)
  • 0x0006 (FaxPolicyType)
  • 0x0007 (all three of the above)


required: true
default value[range]: NA

struct unsp__CACPolicyVideoCodecsAllowed* unsp__CreateCACPolicyRequest::CACPolicyVideoCodecsAllowed

List of allowed Video Codecs.


required: false

xsd__short* unsp__CreateCACPolicyRequest::CallLimit

If the CAC policy is to impose a limit on the number of calls, this parameter should be specified.


required: false
default value[range]: -1

bool* unsp__CreateCACPolicyRequest::Directionalization

Directionalization.


required: false
default value[range]: false

struct unsp__DynamicCACPolicyInfo* unsp__CreateCACPolicyRequest::DynamicCACPolicyInfo

Dynamic CAC Policy Info.


required: false

xsd__boolean* unsp__CreateCACPolicyRequest::GenerateAlarm

Enable or disable generation of alarms when the CACPolicyLimitType exceeds its thresholds.


required: false
default value[range]: false

enum unsp__ProfileLevel* unsp__CreateCACPolicyRequest::MaximumProfileLevel

Maximum allowed profile level for H.264.


required: false
default value[range]: NA

xsd__int* unsp__CreateCACPolicyRequest::MaxInBandwidth

Maximum Incoming Bandwidth (Kbps or Units).


required: false

xsd__short* unsp__CreateCACPolicyRequest::MaxNumOfInCalls

Maximum number of Incoming Calls.


required: false

xsd__short* unsp__CreateCACPolicyRequest::MaxNumOfOutCalls

Maximum number of Outgoing Calls.


required: false

xsd__int* unsp__CreateCACPolicyRequest::MaxOutBandwidth

Maximum Outgoing Bandwidth (Kbps or Units).


required: false

xsd__int* unsp__CreateCACPolicyRequest::MaxVideoCodecBandWidth

The maximum bandwidth for VP8 and H.264 Codecs.


required: false
default value[range]: 4000000 [64000-240000000]

xsd__string unsp__CreateCACPolicyRequest::OperatorId

Operator Id.

See Also
unsp__OperatorId
xsd__int* unsp__CreateCACPolicyRequest::transportOverhead

Transport Overhead.


required: false
default value[range]: 10 [0-100]

bool* unsp__CreateCACPolicyRequest::USDoDAsac

US DoD ASAC.


required: false
default value[range]: false

bool* unsp__CreateCACPolicyRequest::useTIASForBWCalculation

Use TIAS for BW Calculation.


required: false
default value[range]: false


The documentation for this struct was generated from the following file: