switchConnection

Last Updated : Aug 28, 2024 |
This API is used to add or edit Switch connections with Communication Manager.
Note:
The Cluster Mode enablement is reserved for future use.
Prolog information
Syntax
switchConnection add [switchName] [msgPeriod]
  • Enables Cluster Mode and set ispe=true
OR
switchConnection add [switchName] [switchPassword] [msgPeriod] [isPe] [h323tls] [aesCert] [isHostValidate]
switchConnection update [switchName] -pw switchPassword -pe isPe -h h323tls -c aesCert -hvisHostValidate -cm clusterMode
  • By default ispe=true if clusterMode=true
switchConnection editPEClan [switchName] [ip]
switchConnection editH323 [switchName] [ip]
switchConnection editCluster [switchName] [kafkaBootstrapServers] [customerId]
switchConnection deleteConnection [switchName]
switchConnection deletePEClan [switchName] [ip]
switchConnection deleteH323 [ip]
Following are the examples:
  • switchConnection add switchCM avaya12345avaya 30 true false false
  • switchConnection deletePEClan switchCM 10.133.68.56
  • switchConnection editCluster switchCM kafkasvr1:32290,kafkasvr2:32290,kafkasvr3:32290 ID12345
where:
Argument
Description
add
Adds switch with corresponding switchname and other parameters.
update
Updates the parameters related to a particular switch.
editPEClan
Adds PE/CLAN IP for corresponding switch.
editH323
Adds H323 IP for switch.
editCluster
Updates the Kafka Bootstrap Server details related to a particular switch.
deleteConnection
Deletes switch for the given switch name.
deletePEClan
Deletes associated PE/CLAN IP.
deleteH323
Deletes associated H323 IP.
msgPeriod
Can have values from 1 to 72.
isPe, h323tls, aesCert, isHostValidate
Can have the following values:
  • .
  • Note:
    AES supports Hostvalidate argument from Release 8.1.3 and later.
    Return codes:
    Return code
    Description
    4
    Invalid msgPeriod.
    5
    Switch does not exist.
    6
    Max number of Processor Ethernet connections reached.
    7
    Cannot delete if there are active Processor Ethernet for the switch connection.
    8
    Cannot delete if there are links administered for the Switch Connection. Remove the Processor Ethernet first.
    9
    Cannot delete if the Processor Ethernet is active.
    10
    H323 Gatekeeper does not exist.
    11
    Switch already exists.
    12
    Maximum number of Switch Connections reached.
    13
    Invalid switch name.
    14
    Invalid password.