Endpoint Definitions and Methods.
More...
|
| enum | unsp__EndpointType {
EtIgnored = -3,
EtUnused = -2,
EtUnassigned = -1,
EtH323Term = 1,
EtH323Gw,
EtH323Mcu,
EtSip,
EtH323All = 99
} |
| | Endpoint Type. More...
|
| |
| enum | unsp__EndpointSortType {
EndpointStUnassigned = -1,
EndpointStID,
EndpointStEpType,
EndpointStAccountAuth,
EndpointStEpName,
EndpointStEpOperationalState
} |
| | Endpoint Sort Type. More...
|
| |
| enum | unsp__DnsSrv {
DnsSrvUnassigned = -1,
DnsSrvDisabled,
DnsSrvEnabled
} |
| | DNS Srv. More...
|
| |
| enum | unsp__EndpointNNIType {
NNITypeUnused = -2,
NNITypeUnassigned = -1,
NNITypeOpenScapeVoice = 0,
NNITypeHipath4000,
NNITypePSTNGateway,
NNITypeOther
} |
| | Endpoint NNI Type. More...
|
| |
| enum | unsp__OperationalState {
Undefined = -1,
Normal,
CommunicationLost,
Inaccessible,
NormalAuditing,
InaccessibleAuditing
} |
| | Operational State. More...
|
| |
| enum | unsp__EpFailover {
EpFailoverUnassigned = -1,
EpFailoverOff,
EpFailoverOn
} |
| | Endpoint Failover. More...
|
| |
| enum | unsp__QueryEndpointType {
QueryEPTypeDefault = 0,
QueryEPTypeAssociatedEndpoints = 1,
QueryEPTypeCandidateRepEndpoints = 2
} |
| | Query Endpoint Type. More...
|
| |
| enum | unsp__EndpointAuditType {
eAuditTypeEnable = 0,
eAuditTypePeriodicEnable,
eAuditTypePeriodicDisable
} |
| | audit types for auditing an endpoint More...
|
| |
Endpoint Definitions and Methods.
Endpoints are external devices, e.g. Gateways, Proxies or SIP Trunks and also SIP endpoints, like SIP telephones and analog endpoints. An endpoint is a network component, such as an originating or terminating device. An endpoint can be a DN that does not have a number associated with it yet. An Endpoint Profile enables you to set parameters for that endpoint.
Endpoint Management Levels
Endpoints and Endpoint Profiles can be managed on the following two levels:
- on system-wide level
- on Business Group level
DNS Srv.
| Enumerator |
|---|
| DnsSrvUnassigned |
Unassigned.
|
| DnsSrvDisabled |
Disabled.
|
| DnsSrvEnabled |
Enabled.
|
audit types for auditing an endpoint
| Enumerator |
|---|
| eAuditTypeEnable |
Enable auditing, Old functionality.
|
| eAuditTypePeriodicEnable |
Auditing periodic enable.
|
| eAuditTypePeriodicDisable |
Auditing periodic disable.
|
Endpoint NNI Type.
| Enumerator |
|---|
| NNITypeUnused |
Unused.
|
| NNITypeUnassigned |
Unassigned.
|
| NNITypeOpenScapeVoice |
Openscape Voice.
|
| NNITypeHipath4000 |
Hipath 4000.
|
| NNITypePSTNGateway |
PSTN Gateway.
|
| NNITypeOther |
Other.
|
Endpoint Sort Type.
| Enumerator |
|---|
| EndpointStUnassigned |
Unassigned.
|
| EndpointStID |
Endpoint ID.
|
| EndpointStEpType |
Endpoint Type.
|
| EndpointStAccountAuth |
Endpoint Account Authentication.
|
| EndpointStEpName |
Endpoint Name.
|
| EndpointStEpOperationalState |
Endpoint Operational State.
|
Endpoint Type.
| Enumerator |
|---|
| EtIgnored |
Ignored.
|
| EtUnused |
Unused.
|
| EtUnassigned |
Unassigned.
|
| EtH323Term |
H323Term.
|
| EtH323Gw |
H323Gw.
|
| EtH323Mcu |
H323Mcu.
|
| EtSip |
Sip.
|
| EtH323All |
H323All.
|
Endpoint Failover.
| Enumerator |
|---|
| EpFailoverUnassigned |
Unassigned.
|
| EpFailoverOff |
Off.
|
| EpFailoverOn |
On.
|
Operational State.
| Enumerator |
|---|
| Undefined |
Undefined.
|
| Normal |
Normal.
|
| CommunicationLost |
Communication Lost.
|
| Inaccessible |
Inaccessible.
|
| NormalAuditing |
Normal Auditing.
|
| InaccessibleAuditing |
Inaccessible Auditing.
|
Query Endpoint Type.
| Enumerator |
|---|
| QueryEPTypeDefault |
Default.
|
| QueryEPTypeAssociatedEndpoints |
Associated Endpoints.
|
| QueryEPTypeCandidateRepEndpoints |
Candidate Representative Endpoints.
|
Creates an Endpoint.
- Parameters
-
| CreateEndpointRequest | API request |
| CreateEndpointResult | API result |
MP2 command: Endpoint [Attributes]
This method retrieves the list of Associated Endpoints.
- Parameters
-
| GetAssociatedSipEndpointListRequest | API request |
| GetAssociatedSipEndpointListResult | API result |
Modifies multiple Endpoints with a single API invocation.
- Parameters
-
| MassModifyEndpointsRequest | API request |
| MassModifyEndpointsResult | API result |
Modifies an Endpoint.
- Parameters
-
| ModifyEndpointRequest | API request |
| ModifyEndpointResult | API result |
MP2 command: ModifyEndpoint [Attributes]
Queries Endpoints.
- Parameters
-
| QueryEndpointRequest | API request |
| QueryEndpointResult | API result |
Removes an Endpoint.
- Parameters
-
| RemoveEndpointRequest | API request |
| RemoveEndpointResult | API result |
MP2 command: RemoveEndpoint [Attributes]
Performs an on demand PRM audit for a subscriber or NNI endpoint.
- Parameters
-
| TestAuditEndpointRequest | API request |
| TestAuditEndpointResult | API result |