[Index]

Model: relation/HcsIOSDeviceREL

IOS Devices

Full HTML Help

In VOSS Automate, you can set up IOS devices such as SIP Local Gateways and Analog Gateways. And you can set up Command Builders to generate the appropriate IOS commands, which allow you to copy to the IOS device CLI.

Related Topics

Command Builders in the Core Feature Guide

IOS Device Management Workflow

This section outlines a possible workflow for setting up Local Break Out (LBO) using a SIP Local Gateway. This workflow copies IOS commands to the IOS device CLI after each step. Alternatively, you can use the consolidate commands tool to create one set of IOS commands to run all at once.

Perform these steps:

  1. Create customized Command Builders for events. Either add new ones, or clone the default ones and update the clones. See Set up a Command Builder or Clone a Command Builder.
  2. Add an IOS device at customer hierarchy level. See Set up an IOS Device.
  3. View the IOS Commands log and copy commands to the IOS device CLI. See View IOS Commands Log.
  4. Add SIP Local Gateways at customer hierarchy level. See:

Set up SIP Local Gateway in the Core Feature Guide

  1. View the IOS Commands log and copy commands to the IOS device CLI. See View IOS Commands Log.
  2. Perform manual configuration on the SIP Local Gateway. See IOS Gateway Manual Configuration.
  3. Associate SIP Local Gateways to sites. See:

Associate / Disassociate SIP Local Gateway to a Site in the Core Feature Guide

  1. View the IOS Commands log and copy commands to the IOS device CLI. See View IOS Commands Log.
  2. Create E.164 Associations. See:

Associate a Set of E164 Numbers to One Internal Number in the Core Feature Guide

Associate a Range of E164 Numbers to a Range of Internal Numbers in the Core Feature Guide

  1. View the IOS Commands log and copy commands to the IOS device CLI. See View IOS Commands Log.

Set up an IOS Device

Full HTML Help

Perform these steps:

  1. Log in as provider, reseller, or customer administrator.
  2. Set the hierarchy path to the customer hierarchy node where you want to set up the IOS Device.
  3. Choose Device Management > IOS > IOS Devices.
  4. Click Add.
  5. Provide the following information:
Field Description
IOS Device Name Enter the name for the IOS Device. This field is mandatory.
Description Enter a description for the IOS Device.
Prime Collaboration Select the Prime Collaboration to manage the IOS Device.
  1. In the Network Addresses pane, configure the SERVICE_PROVIDER_SPACE address space.
Field Description
Address Space Address Space Type. SERVICE_PROVIDER_SPACE is the default. This field is required.
IPV4 Address Enter the IP address of the IOS Device.
Host Name

The Host Name field is automatically populated with the IOS Device Name. If the IOS Device Name is not the host name, you can edit this field to provide the host name, or provide an IP address in the IPV4 Address field.

Note: Either a host name or an IP address is required. If both are provided, the host name is used. If a host name is provided must be resolvable by the IOS Device.
Domain The domain of the IOS Device.
Description An optional description for the network address

If NAT is used, also configure an APPLICATION_SPACE network address.

If a double NAT is deployed, also configure a CUSTOMER_SPACE network address.

  1. Optionally, expand Credentials.

    1. Add credentials for CLI, SNMP_V2, SNMP_V3 credentials types. Click + to add more credentials.
    2. For CLI and SNMP_V3, fill in the user ID and password that you configured when you installed the IOS Device. For SNMP_V2, only the password is required.
    3. For SNMP credentials, choose RO (Read-only) or RW (Read or Write) for the Access Type. The default is RO.
    4. Provide an optional description for the credential.

    SNMP credentials are used by PCA to manage the IOS Device. CLI credentials are used to log in to the IOS Device.

    Note:

    SNMP configuration must be done manually on the IOS Device.

  2. Click Save.

Model Details: relation/HcsIOSDeviceREL

Title Description Details
IOS Device Name *
  • Field Name: name
  • Type: String
  • MaxLength: 1024
  • Pattern: ^[A-Za-z0-9_\- ]+$
Host Name *
  • Field Name: host
  • Type: String
  • MaxLength: 1024
Description
  • Field Name: description
  • Type: String
  • MaxLength: 1024
Local Gateway Associated
  • Field Name: localGw
  • Type: Boolean
Analog Gateway Associated
  • Field Name: analogGw
  • Type: Boolean
Ext
  • Field Name: ext
  • Type: Object
Host Name * The host name of IOS device
  • Field Name: ext.host
  • Type: String
Description The description of the IOS device.
  • Field Name: ext.description
  • Type: String
Username The username for the device.
  • Field Name: ext.username
  • Type: String
Password The password for the device.
  • Field Name: ext.password
  • Type: String
  • Is Password: True
  • Store Encrypted: True
Enable Password The enable password
  • Field Name: ext.enable_password
  • Type: String
  • Is Password: True
  • Store Encrypted: True
Port The port of the IOS device.
  • Field Name: ext.port
  • Type: String
Cpe
  • Field Name: cpe
  • Type: Object
description
  • Field Name: cpe.description
  • Type: ["String", "Null"]
isMediaDevice
  • Field Name: cpe.isMediaDevice
  • Type: ["Boolean", "Null"]
Clone
  • Field Name: clone
  • Type: Object
description
  • Field Name: cpe.clone.description
  • Type: ["String", "Null"]
isDeletable
  • Field Name: cpe.clone.isDeletable
  • Type: ["Boolean", "Null"]
isGateway
  • Field Name: cpe.clone.isGateway
  • Type: ["Boolean", "Null"]
isSRST
  • Field Name: cpe.clone.isSRST
  • Type: ["Boolean", "Null"]
isCubeEnterprise
  • Field Name: cpe.clone.isCubeEnterprise
  • Type: ["Boolean", "Null"]
cluster
  • Field Name: cpe.clone.cluster
  • Type: ["String", "Null"]
  • Target: device/hcmf/Cluster
  • Format: uri
cdmUpdateTimestamp
  • Field Name: cpe.clone.cdmUpdateTimestamp
  • Type: ["String", "Null"]
credentials
  • Field Name: credentials
  • Type: ["Array", "Null"]
password_CommunityString
  • Field Name: cpe.clone.credentials.password_CommunityString
  • Type: ["String", "Null"]
  • Is Password: True
description
  • Field Name: cpe.clone.credentials.description
  • Type: ["String", "Null"]
userID
  • Field Name: cpe.clone.credentials.userID
  • Type: ["String", "Null"]
typeCredential *
  • Field Name: cpe.clone.credentials.typeCredential
  • Type: String
  • Choices: ["SNMP_V1", "SNMP_V2", "SNMP_V3", "ADMIN", "PLATFORM", "WMI", "IOS_ENABLE", "HTTP", "CLI", "OPERATOR", "SFTP", "JTAPI"]
isModifiable
  • Field Name: cpe.clone.credentials.isModifiable
  • Type: ["Boolean", "Null"]
cdmUpdateTimestamp
  • Field Name: cpe.clone.credentials.cdmUpdateTimestamp
  • Type: ["String", "Null"]
typeSNMPAccess Default: RO
  • Field Name: cpe.clone.credentials.typeSNMPAccess
  • Type: ["String", "Null"]
  • Default: RO
  • Choices: ["RO", "RW"]
id
  • Field Name: cpe.clone.credentials.id
  • Type: ["String", "Null"]
syncTimestamp
  • Field Name: cpe.clone.credentials.syncTimestamp
  • Type: ["String", "Null"]
isDeletable
  • Field Name: cpe.clone.credentials.isDeletable
  • Type: ["Boolean", "Null"]
bkCustomer_shortName
  • Field Name: cpe.clone.bkCustomer_shortName
  • Type: ["String", "Null"]
id
  • Field Name: cpe.clone.id
  • Type: ["String", "Null"]
isMediaDevice
  • Field Name: cpe.clone.isMediaDevice
  • Type: ["Boolean", "Null"]
name *
  • Field Name: cpe.clone.name
  • Type: String
monitorsPrimeCollab
  • Field Name: cpe.clone.monitorsPrimeCollab
  • Type: ["String", "Null"]
  • Target: device/hcmf/PrimeCollab
  • Format: uri
bkCustomerLocation_shortName
  • Field Name: cpe.clone.bkCustomerLocation_shortName
  • Type: ["String", "Null"]
isModifiable
  • Field Name: cpe.clone.isModifiable
  • Type: ["Boolean", "Null"]
networkAddresses
  • Field Name: networkAddresses
  • Type: ["Array", "Null"]
domain
  • Field Name: cpe.clone.networkAddresses.domain
  • Type: ["String", "Null"]
iPAddrV4
  • Field Name: cpe.clone.networkAddresses.iPAddrV4
  • Type: ["String", "Null"]
description
  • Field Name: cpe.clone.networkAddresses.description
  • Type: ["String", "Null"]
iPAddrV6
  • Field Name: cpe.clone.networkAddresses.iPAddrV6
  • Type: ["String", "Null"]
hostShortNameOnly
  • Field Name: cpe.clone.networkAddresses.hostShortNameOnly
  • Type: ["String", "Null"]
isModifiable
  • Field Name: cpe.clone.networkAddresses.isModifiable
  • Type: ["Boolean", "Null"]
isSRVAddress *
  • Field Name: cpe.clone.networkAddresses.isSRVAddress
  • Type: Boolean
typeAddressSpace *
  • Field Name: cpe.clone.networkAddresses.typeAddressSpace
  • Type: String
  • Choices: ["APPLICATION_SPACE", "SERVICE_PROVIDER_SPACE", "CUSTOMER_SPACE"]
cdmUpdateTimestamp
  • Field Name: cpe.clone.networkAddresses.cdmUpdateTimestamp
  • Type: ["String", "Null"]
id
  • Field Name: cpe.clone.networkAddresses.id
  • Type: ["String", "Null"]
syncTimestamp
  • Field Name: cpe.clone.networkAddresses.syncTimestamp
  • Type: ["String", "Null"]
isDeletable
  • Field Name: cpe.clone.networkAddresses.isDeletable
  • Type: ["Boolean", "Null"]
cUOM
  • Field Name: cpe.clone.cUOM
  • Type: ["String", "Null"]
  • Target: device/hcmf/CUOM
  • Format: uri
customerLocation *
  • Field Name: cpe.clone.customerLocation
  • Type: String
  • Target: device/hcmf/CustomerLocation
  • Format: uri
isRouter
  • Field Name: cpe.clone.isRouter
  • Type: ["Boolean", "Null"]
type * Default: CustomerEquipment
  • Field Name: cpe.clone.type
  • Type: String
  • Default: CustomerEquipment
syncTimestamp
  • Field Name: cpe.clone.syncTimestamp
  • Type: ["String", "Null"]
isGateway
  • Field Name: cpe.isGateway
  • Type: ["Boolean", "Null"]
isSRST
  • Field Name: cpe.isSRST
  • Type: ["Boolean", "Null"]
isCubeEnterprise
  • Field Name: cpe.isCubeEnterprise
  • Type: ["Boolean", "Null"]
cluster
  • Field Name: cpe.cluster
  • Type: ["String", "Null"]
  • Target: device/hcmf/Cluster
  • Format: uri
cdmUpdateTimestamp
  • Field Name: cpe.cdmUpdateTimestamp
  • Type: ["String", "Null"]
credentials
  • Field Name: credentials
  • Type: ["Array", "Null"]
password_CommunityString
  • Field Name: cpe.credentials.password_CommunityString
  • Type: ["String", "Null"]
  • Is Password: True
description
  • Field Name: cpe.credentials.description
  • Type: ["String", "Null"]
userID
  • Field Name: cpe.credentials.userID
  • Type: ["String", "Null"]
typeCredential *
  • Field Name: cpe.credentials.typeCredential
  • Type: String
  • Choices: ["SNMP_V1", "SNMP_V2", "SNMP_V3", "ADMIN", "PLATFORM", "WMI", "IOS_ENABLE", "HTTP", "CLI", "OPERATOR", "SFTP", "JTAPI"]
isModifiable
  • Field Name: cpe.credentials.isModifiable
  • Type: ["Boolean", "Null"]
cdmUpdateTimestamp
  • Field Name: cpe.credentials.cdmUpdateTimestamp
  • Type: ["String", "Null"]
typeSNMPAccess Default: RO
  • Field Name: cpe.credentials.typeSNMPAccess
  • Type: ["String", "Null"]
  • Default: RO
  • Choices: ["RO", "RW"]
id
  • Field Name: cpe.credentials.id
  • Type: ["String", "Null"]
syncTimestamp
  • Field Name: cpe.credentials.syncTimestamp
  • Type: ["String", "Null"]
isDeletable
  • Field Name: cpe.credentials.isDeletable
  • Type: ["Boolean", "Null"]
bkCustomer_shortName
  • Field Name: cpe.bkCustomer_shortName
  • Type: ["String", "Null"]
id
  • Field Name: cpe.id
  • Type: ["String", "Null"]
isRouter
  • Field Name: cpe.isRouter
  • Type: ["Boolean", "Null"]
customerLocation *
  • Field Name: cpe.customerLocation
  • Type: String
  • Target: device/hcmf/CustomerLocation
  • Format: uri
monitorsPrimeCollab
  • Field Name: cpe.monitorsPrimeCollab
  • Type: ["String", "Null"]
  • Target: device/hcmf/PrimeCollab
  • Format: uri
bkCustomerLocation_shortName
  • Field Name: cpe.bkCustomerLocation_shortName
  • Type: ["String", "Null"]
networkAddresses
  • Field Name: networkAddresses
  • Type: ["Array", "Null"]
domain
  • Field Name: cpe.networkAddresses.domain
  • Type: ["String", "Null"]
iPAddrV4
  • Field Name: cpe.networkAddresses.iPAddrV4
  • Type: ["String", "Null"]
description
  • Field Name: cpe.networkAddresses.description
  • Type: ["String", "Null"]
iPAddrV6
  • Field Name: cpe.networkAddresses.iPAddrV6
  • Type: ["String", "Null"]
hostShortNameOnly
  • Field Name: cpe.networkAddresses.hostShortNameOnly
  • Type: ["String", "Null"]
isModifiable
  • Field Name: cpe.networkAddresses.isModifiable
  • Type: ["Boolean", "Null"]
isSRVAddress *
  • Field Name: cpe.networkAddresses.isSRVAddress
  • Type: Boolean
typeAddressSpace *
  • Field Name: cpe.networkAddresses.typeAddressSpace
  • Type: String
  • Choices: ["APPLICATION_SPACE", "SERVICE_PROVIDER_SPACE", "CUSTOMER_SPACE"]
cdmUpdateTimestamp
  • Field Name: cpe.networkAddresses.cdmUpdateTimestamp
  • Type: ["String", "Null"]
id
  • Field Name: cpe.networkAddresses.id
  • Type: ["String", "Null"]
syncTimestamp
  • Field Name: cpe.networkAddresses.syncTimestamp
  • Type: ["String", "Null"]
isDeletable
  • Field Name: cpe.networkAddresses.isDeletable
  • Type: ["Boolean", "Null"]
name *
  • Field Name: cpe.name
  • Type: String
isModifiable
  • Field Name: cpe.isModifiable
  • Type: ["Boolean", "Null"]
cUOM
  • Field Name: cpe.cUOM
  • Type: ["String", "Null"]
  • Target: device/hcmf/CUOM
  • Format: uri
isDeletable
  • Field Name: cpe.isDeletable
  • Type: ["Boolean", "Null"]
type * Default: CustomerEquipment
  • Field Name: cpe.type
  • Type: String
  • Default: CustomerEquipment
syncTimestamp
  • Field Name: cpe.syncTimestamp
  • Type: ["String", "Null"]