Summary
This article describes the certified specifications Provisioning supports for Calix. Provisioning currently supports a subset of the Calix provisioning capabilities. The article contains a detailed list of actions and parameters.
Specifications
Provider: Calix
Link: https://www.calix.com/
Application Interface: Calix Management System (CMS)
Application Version: R15.x Northbound Interface
CostGuard Calix Provider Version: 1.11 (1.12.221)
CostGuard Bundle Version: 24.2
Certified Platforms:
E7 OS xDSL Service
E7 GPON ONT Service
E7 denotes the following Calix platforms
E7-2
E7-20
E3-48C
E5-48/C
E5-400
Overview
The section below describes how Provisioning interacts with Calix APIs and offers helpful advice and guidelines.
Calix generally requires database IDs as values sent in the API, not the text value or display name. It’s recommended to create custom lists that map the display name to the value sent in the API.
A sampling of some fields that require database IDs as values are:
Bandwidth Profile
Dial Plan
Security Profile
Service Tag Action
SIP Profile
An example custom list is outlined below. See Provisioning documentation for an overview of how to create a custom list.
Calix requires ‘NTWK-‘added to the Node name in CMS. For example, if the Node Name in CMS is ‘Rochester’ the API will expect ‘NTWK-Rochester.’ You can create a custom list to identify the display name in Calix and the value the API is expecting.
When updating an Ethernet Port, the Calix API expects 200 + the port number. For example, if CMS displays the port as 1, the API expects 201. You can create a custom list to identify the display name in Calix and the value the API is expecting.
There are at least three calls made for every Calix action.
A call to login in and get a session id.
The call to perform the requested action. Some actions have multiple calls to perform the update.
A call to log out and end the session.
Parameters will only display as required if they’re required for every call. Some fields may be conditionally required. Based on the enablement of a preceding parameter, the subsequent parameter is now required. Conditionally required parameters will not display as required on the Provisioning profile pages but will be identified in the Action Details section. If a required value is not populated on the action, provisioning will error the request before sending it to the endpoint and state that it’s a required field.
Available Actions:
The current actions supported for Calix include:
Provider | Platform | Action | Available |
|---|---|---|---|
Calix | E7 GPON ONT | 21.2 | |
Calix | E7 GPON ONT | 21.2 | |
Calix | E7 GPON ONT | 21.2 | |
Calix | E7 GPON ONT | 21.2 | |
Calix | E7 GPON ONT | 21.2 | |
Calix | E7 GPON ONT | 21.2 | |
Calix | E7 GPON ONT | 21.2 | |
Calix | E7 GPON ONT | 21.2 | |
Calix | E7 GPON ONT | 21.2 | |
Calix | E7 OS xDSL | 23.6 | |
Calix | E7 OS xDSL | 21.2 | |
Calix | E7 OS xDSL | 21.2 | |
Calix | E7 OS xDSL | 21.2 | |
Calix | E7 OS xDSL | 21.2 | |
Calix | E7 OS xDSL | 21.2 | |
Calix | E7 OS xDSL | 21.2 | |
Calix | E7 OS xDSL | 21.2 | |
Calix | E7 OS xDSL | 21.2 |
Action Detail for E7 GPON ONT Services
The section below reviews the available parameters and supported actions for provisioning E7 GPON ONT services.
Add E7 GPON Data Service
The action defines the objects required to create the data Service on E7 GPON ONT ethernet ports.
The action will make the following calls:
Configure the Ethernet Port.
Provision the data service.
Available Parameters
Name | Type | Required | Notes |
|---|---|---|---|
Connection Information | |||
Address | String | Required | URL of the Calix WS |
Username | String | Required | Username to login |
Password | String | Required | Password to login |
General Information | |||
Nodename | String | Required | Nodename (format: NTWK-XXXX) |
ONT ID | Number | Required | Positive Integer |
ONT Slot | List | Required | |
Data/Ethernet Port | Number | Required | Positive Integer |
Data/Ethernet Service | Number | Required | Positive Integer |
Subscriber ID | String | Required | |
Description | String | Optional | Description of the Service |
Service Information | |||
WAN Protocol | List | Optional | Choose dhcp or static |
Service Tag Action | String | Required | Positive Integer between 1 -255 |
Service Tag Action Name | String | Required | Name of Action Tag |
BW Profile | Number | Required | Positive Integer between 1 -300. Recommend creating a custom list. |
Upstream Peak Rate | String | Optional | Format Example = 100m |
Downstream Peak Rate | String | Optional | Format Example = 100m |
Security Profile | Number | Required | |
Outer VLAN ID | Number | Optional | Positive Integer with a value between 2 – 4093. Do not include if the value is not required by Service Tag Action |
Service Information | |||
IP Address | String | Optional* | Required if WAN Protocol is Static |
Subnet Mask | String | Optional* | Required if WAN Protocol is Static |
Gateway | String | Optional* | Required if WAN Protocol is Static |
Primary DNS Server | String | Optional* | Required if WAN Protocol is Static |
Secondary DNS Server | String | Optional* | Required if WAN Protocol is Static |
* Field is conditionally required. The selection of values in preceding fields may change the field from optional to required.
Add E7 GPON SIP Service
The action defines the objects required to update and create the SIP Service on E7 GPON ONT voice ports.
The action will make the following calls:
Update the IP Host
Provision the SIP Service
There are two options for Password fields:
Enter your own password in the ‘Password’ parameter.
Have the system generate a random password using the ‘Password Seed’ parameter.
The password seed will be used to randomly generate a password. It is recommended to use an object that will be variable on each service or order, for example, internal object id or account number. If using in combination with Metaswitch, use the same password seed in Metaswitch as you do in Calix.
It is recommended to set up voice service on Metaswitch before creating service on Calix.
Available Parameters
Name | Type | Required* | Notes |
|---|---|---|---|
Connection Information | |||
Address | String | Required | URL of the Calix WS |
Username | String | Required | Username to login |
Password | String | Required | Password to login |
General Information | |||
Nodename | String | Required | Nodename (format: NTWK-XXXX) |
ONT ID | Number | Required | Positive Integer |
Voice Port | Number | Required | Positive Integer |
META Group Information | |||
Username | String | Required | Username to log in to Metaswitch |
Generate Password | Boolean | Optional | Yes or No. If no, populate the password field. If yes, populate the password seed field |
Password Seed | String | Optional* | Required if Generate Password = Yes. The system will generate a random password based on the seed value. Recommend using a variable value like InternalObjectID. Seed value should be the same in Calix as Metaswitch. |
Password | String | Optional* | Enter Password |
URI | String | Required | Must match the value in Metaswitch. |
Service Information | |||
Voice Service | Number | Optional | Positive Integer. Typically a value of 1 |
Host Protocol | List | Optional | Choose ‘dhcp’ or ‘static’ |
Service Tag Action | Number | Optional | Positive Integer: Service Tag Action ID |
Service Tag Action Name | String | Optional | Service Tag Action Name |
SIP Profile | Number | Optional | Default or create a custom list. |
Dial Plan | Number | Optional | |
Outer VLAN ID | Number | Optional | Positive Integer. Required for Certain Service Tags. Values 2 – 4093. Do not include if the value is not required by Service Tag Action. |
Call Waiting | Boolean | Optional | “Yes” or “No”. Not included if not provided. |
Caller ID | Boolean | Optional | “Yes” or “No”. Not included if not provided. |
Three Way Calling | Boolean | Optional | “Yes” or “No”. Not included if not provided. |
T38 Fax Relay | Boolean | Optional | “Yes” or “No”. Not included if not provided. |
Message Waiting Indicator | Boolean | Optional | “Yes” or “No”. Not included if not provided. |
* Field is conditionally required. The selection of values in preceding fields may change the field from optional to required.
Delete E7 GPON ONT
The action defines the objects required to delete E7 GPON ONTs.
The action lets administrators choose between performing a force delete or non-force delete.
Force Delete = Yes – Deletes all services on the ONT.
Force Delete = No – All services must be removed from the ONT to be successful.
Available Parameters
Name | Type | Required | Notes |
|---|---|---|---|
Connection Information | |||
Address | String | Required | URL of the Calix WS |
Username | String | Required | Username to login |
Password | String | Required | Password to login |
General Information | |||
Nodename | String | Required | Nodename (format: NTWK-XXXX) |
Force Delete | List | Required | Choose Yes or No |
ONT | Number | Required | ONT ID |
Delete E7 GPON ONT Service
The action defines the objects required to delete services on the E7 GPON ONT.
The action lets you delete the following services:
Data or Video Service
H248 VoIP Service
MGCP VoIP Service
PWE3 Service
SIP Voice Service
TDM Gateway VoIP Service
Choose the service type you’d like to delete in the General Information section and populate the Port and Service values beneath that service type.
Available Parameters
Name | Type | Required* | Notes |
|---|---|---|---|
Connection Information | |||
Address | String | Required | URL of the Calix WS |
Username | String | Required | Username to login |
Password | String | Required | Password to login |
General Information | |||
Nodename | String | Required | Nodename (format: NTWK-XXXX) |
Force Delete | List | Required | Choose Yes or No |
Service Type | List | Required | Choose Service Type |
ONT | Number | Required | Positive Integer |
ONT Slot Type | List | Required | |
Data or Video Service | |||
Ethernet Port | Number | Optional* | Required when Service Type is Data or Video Service |
Ethernet Service | Number | Optional* | Required when Service Type is Data or Video Service |
H248 VoIP Service | |||
Voice Port | Number | Optional* | Required when Service Type is H248 Gateway VoIP Service |
H248 Gateway Service | Number | Optional* | Required when Service Type is H248 Gateway VoIP Service |
MGCP VoIP Service | |||
Voice Port | Number | Optional* | Required when Service Type is MGCP VoIP Service |
MGCP Gateway Service | Number | Optional* | Required when Service Type is MGCP VoIP Service |
PWE3 Service | |||
T1/E1 Port | Number | Optional* | Required when Service Type is PWE3 Service |
PWE3 Service | Number | Optional* | Required when Service Type is PWE3 Service |
SIP Voice Service | |||
Voice Port | Number | Optional* | Required when Service Type is SIP VoIP Service |
SIP Service | Number | Optional* | Required when Service Type is SIP VoIP Service |
TDM Gateway VoIP Service | |||
Voice Port | Number | Optional* | Required when Service Type is TDM Gateway VoIP Service |
TDM Gateway Service | Number | Optional* | Required when Service Type is TDM Gateway VoIP Service |
* Field is conditionally required. The selection of values in preceding fields may change the field from optional to required.
Enable/Disable E7 GPON ONT Port
The action defines the objects required to enable or disable a Port on E7 GPON ONTs.
The action lets you enable or disable the following Port types:
Fast Ethernet Port
FB Port
Gigabit Ethernet Port
Hot RF Video
HPNA Ethernet Port
RF AVO Port
RF Video
RG Port
T1/E1 Port
Voice Port
The Admin Status field indicates if you want to enable or disable the port.
Select a Port type in General Information, then add the port number to the corresponding Port type under Port Specific Information.
Available Parameters
Name | Type | Required | Notes |
|---|---|---|---|
Connection Information | |||
Address | String | Required | URL of the Calix WS |
Username | String | Required | Username to login |
Password | String | Required | Password to login |
General Information | |||
Nodename | String | Required | Nodename (format: NTWK-XXXX) |
Admin Status | List | Required | Choose ‘Enabled’ or ‘Disabled’ |
Port Type | List | Required | Choose Port Type |
ONT | Number | Required | Positive Integer |
ONT Slot Type | List | Required* | Required, expect when Port Type = ‘RF AVO Port’ |
Port Specific Information | |||
Fast Ethernet Port | Number | Optional* | Required when Port Type = Fast Ethernet Port |
FB Port | Number | Optional* | Required when Port Type = FB Port |
Gigabit Ethernet Port | Number | Optional* | Required when Port Type = Gigabit Ethernet Port |
Hot RF Video | Number | Optional* | Required when Port Type = RF Video and ONT Type = Hot RF Video |
HPNA Ethernet Port | Number | Optional* | Required when Port Type = HPNA Ethernet |
RF AVO Port | Number | Optional* | Required when Port Type = RF AVO Port |
RF Video | Number | Optional* | Required when Port Type = RF Video and ONT Type = RF Video |
RG Port | Number | Optional* | Required when Port Type = RG Port |
T1/E1 Port | Number | Optional* | Required when Port Type = T1/E1 Port |
Voice Port | Number | Optional* | Required when Port Type = Voice Port |
* Field is conditionally required. The selection of values in preceding fields may change the field from optional to required.
Enable/Disable E7 GPON ONT Service
The action defines the objects required to enable or disable services on E7 GPON ONTs.
The action allows you to enable or disable the following services:
Data or Video Service
H248 VoIP Service
MGCP VoIP Service
PWE3 Service
SIP Voice Service
TDM Gateway VoIP Service
The Admin Status field indicates if you want to enable or disable the port.
Choose the service type you’d like to enable or disable in the General Information section and populate the Port and Service values beneath that service type.
Available Parameters
Name | Type | Required | Notes |
|---|---|---|---|
Connection Information | |||
Address | String | Required | URL of the Calix WS |
Username | String | Required | Username to login |
Password | String | Required | Password to login |
General Information | |||
Nodename | String | Required | Nodename (format: NTWK-XXXX) |
Admin Status | List | Required | Choose: |
Service Type | List | Required | Choose Service Type |
ONT | Number | Required | Positive Integer |
ONT Slot Type | List | Required | |
Data or Video Service | |||
Ethernet Port | Number | Optional* | Required when Service Type is Data or Video Service |
Ethernet Service | Number | Optional* | Required when Service Type is Data or Video Service |
H248 VoIP Service | |||
Voice Port | Number | Optional* | Required when Service Type is H248 Gateway VoIP Service |
H248 Gateway Service | Number | Optional* | Required when Service Type is H248 Gateway VoIP Service |
MGCP VoIP Service | |||
Voice Port | Number | Optional* | Required when Service Type is MGCP VoIP Service |
MGCP Gateway Service | Number | Optional* | Required when Service Type is MGCP VoIP Service |
PWE3 Service | |||
T1/E1 Port | Number | Optional* | Required when Service Type is PWE3 Service |
PWE3 Service | Number | Optional* | Required when Service Type is PWE3 Service |
SIP Voice Service | |||
Voice Port | Number | Optional* | Required when Service Type is SIP VoIP Service |
SIP Service | Number | Optional* | Required when Service Type is SIP VoIP Service |
TDM Gateway VoIP Service | |||
Voice Port | Number | Optional* | Required when Service Type is TDM Gateway VoIP Service |
TDM Gateway Service | Number | Optional* | Required when Service Type is TDM Gateway VoIP Service |
* Field is conditionally required. The selection of values in preceding fields may change the field from optional to required.
Link E7 GPON ONT
The action defines the objects required to create the ONT and configure Ethernet Port settings on E7 GPON ONTs.
The action will make the following calls:
Create the ONT
Configure the Ethernet Ports on the ONT
There will be one call per port.
Set the WAN Protocol
In CMS, users typically link the ONT and apply a template for the port settings. The API does not allow the template to be set. It’s recommended to create actions that set the same port configuration as assigning the template in CMS. For example, setting up Ethernet Ports for Remote Gateway.
The port setup actions can complete with partial success. The status note field will indicate how many calls completed with a warning. The warnings happen when you attempt to update a port that does not exist on the model selected. For example, you send a request to update Gigabit Port 8, but the model only has 6 ports. Example status message is shown below.
Available Parameters
Name | Type | Required | Notes |
|---|---|---|---|
Connection Information | |||
Address | String | Required | URL of the Calix WS |
Username | String | Required | Username to login |
Password | String | Required | Password to login |
General Information | |||
Nodename | String | Required | Nodename (format: NTWK-XXXX) |
ONT ID | Number | Required | ID for ONT |
ONT Profile | List | Required | Choose: |
Serial Number | String | Optional | Positive Integer |
Subscriber ID | String | Required | |
Description | String | Optional | Description of the Service |
PWE3 Profile | Number | Required | System Default = 1 |
WAN Protocol | List | Optional | Options: |
Security Profile | Number | Optional | Default value or recommended to create a custom list. |
Data Port Default | |||
Gigabit Ethernet Port 1 | List | Optional | Options: |
Gigabit Ethernet Port 2 | List | Optional | Options: |
Gigabit Ethernet Port 3 | List | Optional | Options: |
Gigabit Ethernet Port 4 | List | Optional | Options: |
Gigabit Ethernet Port 5 | List | Optional | Options: |
Gigabit Ethernet Port 6 | List | Optional | Options: |
Gigabit Ethernet Port 7 | List | Optional | Options: |
Gigabit Ethernet Port 8 | List | Optional | Options: |
Fast Ethernet Port 1 | List | Optional | Options: |
Fast Ethernet Port 2 | List | Optional | Options: |
Update GPON Data Service
The action defines the objects required to update values on an existing E7 GPON ONT data service.
The action can have up to three additional calls, depending on the parameters being updated.
Available Parameters
Name | Type | Required* | Notes |
|---|---|---|---|
Connection Information | |||
Address | String | Required | URL of the Calix WS |
Username | String | Required | Username to login |
Password | String | Required | Password to login |
General Information | |||
Nodename | String | Required | Nodename (format: NTWK-XXXX) |
ONT ID | Number | Required | |
ONT Slot | List | Required | |
Data/Ethernet Port | Number | Required | Positive Integer |
Data/Ethernet Service | Number | Required | Positive Integer |
Subscriber ID | String | Optional | |
Description | String | Optional | Description of the Service |
Port Admin Status | List | Optional | Choose – Enabled or Disabled |
Service Admin Status | List | Optional | Choose – Enabled, Disabled, Enabled No-Alarms |
Service Information | |||
WAN Protocol | List | Optional | Choose dhcp or static |
Service Tag Action | String | Optional | Positive Integer between 1 -255 |
Service Tag Action Name | String | Optional* | Required if Service Tag Action is provided. |
BW Profile | Number | Optional | Positive Integer between 1 -300. Recommend creating a custom list. |
Upstream Peak Rate | String | Optional | Format Example = 100m |
Downstream Peak Rate | String | Optional | Format Example = 100m |
Security Profile | Number | Optional | |
Outer VLAN ID | Number | Optional | Positive Integer with a value between 2 – 4093. Do not include if the value is not required by Service Tag Action |
Service Information | |||
IP Address | String | Optional* | Required if WAN Protocol is Static |
Subnet Mask | String | Optional* | Required if WAN Protocol is Static |
Gateway | String | Optional* | Required if WAN Protocol is Static |
Primary DNS Server | String | Optional* | Required if WAN Protocol is Static |
Secondary DNS Server | String | Optional* | Required if WAN Protocol is Static |
* Field is conditionally required. The selection of values in preceding fields may change the field from optional to required.
Update GPON SIP Service
The action defines the objects required to update values on an existing E7 GPON ONT SIP services.
The action can have up to two additional calls, depending on the parameters being updated.
There are two options for Password fields:
Enter your own password in the ‘Password’ parameter.
Have the system generate a random password using the ‘Password Seed’ parameter.
The password seed will be used to randomly generate a password. It is recommended to use an object that will be variable on each service or order, for example, internal object id or account number. If using in combination with Metaswitch, use the same password seed in Metaswitch as you do in Calix.
Available Parameters
Connection Information | |||
Address | String | Required | URL of the Calix WS |
Username | String | Required | Username to login |
Password | String | Required | Password to login |
General Information | |||
Nodename | String | Required | Nodename (format: NTWK-XXXX) |
ONT ID | Number | Required | Positive Integer |
Voice Port | Number | Required | Positive Integer |
Service Admin Status | List | Optional | Choose: |
META Group Information | |||
Username | String | Optional | Username to log in to Metaswitch |
Generate Password | Boolean | Optional | Yes or No. If no, populate the password field. If yes, populate the password seed field |
Password Seed | String | Optional* | Required if Generate Password = Yes. The system will generate a random password based on the seed value. Recommend using a variable value like InternalObjectID. Seed value should be the same in Calix as Metaswitch. |
Password | String | Optional* | Enter Password |
URI | String | Optional | Must match the value in Metaswitch. |
Service Information | |||
Voice Service | Number | Optional | Positive Integer. Typically a value of 1 |
Host Protocol | List | Optional | Choose ‘dhcp’ or ‘static’ |
Service Tag Action | Number | Optional | |
Service Tag Action Name | String | Optional* | Name of Action Tag |
SIP Profile | Number | Optional | Default or create a custom list. |
Dial Plan | Number | Optional |
* Field is conditionally required. The selection of values in preceding fields may change the field from optional to required.
Action Detail for E7 OS xDSL Services
The section below reviews the available parameters and supported actions for provisioning E7 OS xDSL Services.
Provisioning supports a subset of the E7 OS xDSL provisioning capabilities.
Add E7 OS xDSL Data Service
The request defines the objects required for data service activation for an xDSL port.
Available Parameters
Name | Type | Required | Notes |
|---|---|---|---|
Connection Information | |||
Address | String | Required | URI of the Calix WS |
Username | String | Required | Username to login |
Password | String | Required | Password to login |
General Information | |||
Nodename | String | Required | Nodename (format: NTWK-XXXX) |
Shelf | Number | Required | Positive Integer: Values 1 -10 |
Card | Number | Required | Positive Integer: Values 1 -2 |
Service Information | |||
Ethernet Port | Number | Required | Positive Integer |
Ethernet Service | Number | Required | Positive Integer |
Service Tag Action | List | Required | Default value or create a custom list |
BW Profile | Number | Required | Values are 1 to 300. IDs are required. Recommend creating a custom list mapping bandwidth to ID. |
S-VLAN | Number | Optional | Positive Integer. |
Add E7 OS xDSL Voice Service
The request defines the objects required for SIP Service activation for E7 OS xDSL.
There are two options of password fields:
Enter your own password in the ‘Password’ parameter.
Have the system generate a random password using the ‘Password Seed’ parameter.
The password seed will be used to randomly generate a password. It is recommended to use an object that will be variable on each service or order, for example, internal object id or account number. If using in combination with Metaswitch, use the same password seed in Metaswitch as you do in Calix.
It is recommended to set up voice service on Metaswitch before creating service on Calix.
Available Parameters
Name | Type | Required | Notes |
|---|---|---|---|
Connection Information | |||
Address | String | Required | URL of the Calix WS |
Username | String | Required | Username to login |
Password | String | Required | Password to login |
General Information | |||
Nodename | String | Required | Nodename (format: NTWK-XXXX) |
Shelf | Number | Required | Positive Integer: Values 1 -10 |
Card | Number | Required | Positive Integer: Values 1 -2 |
META Group Information | |||
Username | String | Required | Username to log in to Metaswitch |
Generate Password | String | Optional | Yes or No. If no, populate the password field. If yes, populate the password seed field |
Password Seed | String | Optional* | Required if Generate Password = Yes. The system will generate a random password based on the seed value. Recommend using a variable value like InternalObjectID. Seed value should be the same in Calix as Metaswitch. |
Password | String | Optional* | Enter Password |
URI | String | Required | Must match the value in Metaswitch. |
Service Information | |||
Voice Port | Number | Required | Positive Integer |
SIP Profile | Number | Required | Default value or create a custom list. |
Dial Plan | Number | Required | |
Call Waiting | String | Optional | “true” or “false”. Default value is “false” |
Caller ID | String | Optional | “true” or “false”. Default value is “false” |
Three Way Calling | String | Optional | “true” or “false”. Default value is “false” |
T38 Fax Relay | String | Optional | “true” or “false”. Default value is “false” |
Message Waiting Indicator | String | Optional | “true” or “false”. Default value is “false” |
Apply Template to E7 OS xDSL Port
The action defines the objects required to apply an xDSL template to an E7 OS xDSL port before activating the service.
Name | Type | Required | Notes |
|---|---|---|---|
Connection Information | |||
Address | String | Required | URL of the Calix WS |
Username | String | Required | Username to login |
Password | String | Required | Password to login |
General Information | |||
Nodename | String | Required | Nodename (format: NTWK-XXXX) |
DSL Port Template | Number | Required | |
Shelf | Number | Required | Positive Integer: Values 1 -10 |
Card | Number | Required | Positive Integer: Values 1 -2 |
Delete E7 xDSL Service
The action defines the objects required to delete an E7 OS xDSL service.
The action lets you delete the following services:
Data or Video Service on DSL Bonding Group
Data or Video Service on Ethernet Port
H248 DSL Gateway Service
SIP Voice Service
TDM Gateway VoIP Service
Choose the service you’d like to delete in the General Information section and populate the Port and Service values beneath that service type.
Available Parameters
Name | Type | Required | Notes |
|---|---|---|---|
Connection Information | |||
Address | String | Required | URL of the Calix WS |
Username | String | Required | Username to login |
Password | String | Required | Password to login |
General Information | |||
Nodename | String | Required | Nodename (format: NTWK-XXXX) |
Force Delete | List | Required | Choose Yes or No |
Service Type | List | Required | Choose Service Type |
Shelf | Number | Required | Positive Integer: Values 1 -10 |
Card | Number | Required | Positive Integer: Values 1 -2 |
Data or Video Service on DSL Bonding Group | |||
DSL Bonding Group | Number | Optional* | Required when Service Type is Data or Video Service on DSL Bonding Group |
Ethernet Service | Number | Optional* | Required when Service Type is Data or Video Service on DSL Bonding Group |
Data or Video Service on Ethernet Port | |||
Ethernet Port | Number | Optional* | Required when Service Type is Data or Video Service on Ethernet Port |
Ethernet Service | Number | Optional* | Required when Service Type is Data or Video Service on Ethernet Port |
H248 DSL Gateway Service | |||
Voice Port | Number | Optional* | Required when Service Type is H248 Gateway VoIP Service |
H248 Gateway Service | Number | Optional* | Required when Service Type is H248 Gateway VoIP Service |
SIP Voice Service | |||
Voice Port | Number | Optional* | Required when Service Type is SIP VoIP Service |
SIP Service | Number | Optional* | Required when Service Type is SIP VoIP Service |
TDM Gateway VoIP Service | |||
Voice Port | Number | Optional* | Required when Service Type is TDM Gateway VoIP Service |
TDM Gateway Service | Number | Optional* | Required when Service Type is TDM Gateway VoIP Service |
*Field is conditionally required. The selection of specific values in preceding fields may change the field from option to required.
Enable/Disable E7 OS xDSL Port
The action defines the objects required to enable or disable an E7 OS xDSL Port.
The Admin Status field indicates if you want to enable or disable the port.
Select a Port type in General Information, then add the port number to the corresponding Port type under Port Specific Information.
Available Parameters
Name | Type | Required | Notes |
|---|---|---|---|
Connection Information | |||
Address | String | Required | URL of the Calix WS |
Username | String | Required | Username to login |
Password | String | Required | Password to login |
General Information | |||
Nodename | String | Required | Nodename (format: NTWK-XXXX) |
Admin Status | List | Required | Choose Disabled or Enabled |
Port Type | List | Required | Choose DSL Port or Voice Port |
Shelf | Number | Required | Positive Integer: Values 1 -10 |
Card | Number | Required | Positive Integer: Values 1 -2 |
Port Specific Information | |||
DSL Port | Number | Optional* | Required if Port Type is DSL Port |
Voice Port | Number | Optional* | Required if Port Type is Voice Port |
*Field is conditionally required. The selection of specific values in preceding fields may change the field from option to required.
Enable/Disable E7 OS xDSL Port Service
The action defines the objects required to enable or disable services for E7 OS xDSL.
The Admin Status field indicates if you want to enable or disable the port.
Choose the service you’d like to enable or disable in the General Information section and populate the Port and Service values beneath that service type.
Name | Type | Required | Note+A+A2:D25 |
|---|---|---|---|
Connection Information | |||
Address | String | Required | URL of the Calix WS |
Username | String | Required | Username to login |
Password | String | Required | Password to login |
General Information | |||
Nodename | String | Required | Nodename (format: NTWK-XXXX) |
Admin Status | List | Required | Choose Disabled or Enabled |
Service Type | List | Required | Choose Service Type |
Shelf | Number | Required | Positive Integer: Values 1 -10 |
Card | Number | Required | Positive Integer: Values 1 -2 |
Data or Video Service on DSL Bonding Group | |||
DSL Bonding Group | Number | Optional* | Required when Service Type is Data or Video Service on DSL Bonding Group |
Ethernet Service | Number | Optional* | Required when Service Type is Data or Video Service on DSL Bonding Group |
Data or Video Service on Ethernet Port | |||
Ethernet Port | Number | Optional* | Required when Service Type is Data or Video Service on Ethernet Port |
Ethernet Service | Number | Optional* | Required when Service Type is Data or Video Service on Ethernet Port |
H248 DSL Gateway Service | |||
Voice Port | Number | Optional* | Required when Service Type is H248 Gateway VoIP Service |
H248 Gateway Service | Number | Optional* | Required when Service Type is H248 Gateway VoIP Service |
SIP Voice Service | |||
Voice Port | Number | Optional* | Required when Service Type is SIP VoIP Service |
SIP Service | Number | Optional* | Required when Service Type is SIP VoIP Service |
TDM Gateway VoIP Service | |||
Voice Port | Number | Optional* | Required when Service Type is TDM Gateway VoIP Service |
TDM Gateway Service | Number | Optional* | Required when Service Type is TDM Gateway VoIP Service |
*Field is conditionally required. The selection of specific values in preceding fields may change the field from option to required.
Update E7 OS xDSL Data Service
The action defines the objects required to update values on an existing E7 OS xDSL data service.
The action can have up to two additional calls, depending on the parameters being updated.
Available Parameters
Name | Type | Required* | Notes |
|---|---|---|---|
Connection Information | |||
Address | String | Required | URI of the Calix WS |
Username | String | Required | Username to login |
Password | String | Required | Password to login |
General Information | |||
Nodename | String | Required | Nodename (format: NTWK-XXXX) |
Shelf | Number | Required | Positive Integer: Values 1 -10 |
Card | Number | Required | Positive Integer: Values 1 -2 |
Subscriber ID | String | Optional | |
Description | String | Optional | |
Port Admin Status | List | Optional | Choose – Enabled or Disabled |
Service Admin Status | List | Optional | Choose – Enabled, Disabled, Enabled No-Alarms |
Service Information | |||
Ethernet Port | Number | Required | Positive Integer |
Ethernet Service | Number | Required | Positive Integer |
Service Tag Action | List | Optional | |
BW Profile | Number | Optional | Values are 1 to 300. IDs are required. Recommend creating a custom list map bandwidth to ID. |
S-VLAN | Number | Optional | Positive Integer with a value between 2 – 4093. Do not include if the value is not required by Service Tag Action |
Update E7 OS xDSL Port
The action defines the objects required to update xDSL Ports for data or voice services.
The Port Type parameter determines if the call will update the data or voice port. If updating both voice and data ports, two actions will need to be sent to Calix for both voice and data.
Name | Type | Required* | Notes |
|---|---|---|---|
Connection Information | |||
Address | String | Required | URI of the Calix WS |
Username | String | Required | Username to login |
Password | String | Required | Password to login |
General Information | |||
Nodename | String | Required | Nodename (format: NTWK-XXXX) |
Port Type | String | Required | Choose DSL Port or Voice Port |
Shelf | Number | Required | Positive Integer: Values 1 -10 |
Card | Number | Required | Positive Integer: Values 1 -2 |
Port Specific Information | |||
Subscriber ID | String | Required | Subscriber ID for the customer |
Description | String | Optional | Description of the Service |
DSL Port | Number | Optional* | Required if Port Type = DSL Port: Values 201-248 |
Voice Port | Number | Optional* | Required if Port Type = Voice Port: Values 1-48 |
*Field is conditionally required. The selection of specific values in preceding fields may change the field from option to required.
Update E7 OS xDSL Voice Service
The action defines the objects required to update values on an existing E7 OS xDSL voice services.
The action can have up to three additional calls, depending on the parameters being updated.
There are two options for Password fields:
Enter your own password in the ‘Password’ parameter.
Have the system generate a random password using the ‘Password Seed’ parameter.
The password seed will be used to randomly generate a password. It is recommended to use an object that will be variable on each service or order, for example, internal object id or account number. If using in combination with Metaswitch, use the same password seed in Metaswitch as you do in Calix.
Available Parameters
Name | Type | Required | Notes |
|---|---|---|---|
Connection Information | |||
Address | String | Required | URL of the Calix WS |
Username | String | Required | Username to login |
Password | String | Required | Password to login |
General Information | |||
Nodename | String | Required | Nodename (format: NTWK-XXXX) |
Shelf | Number | Required | Positive Integer: Values 1 -10 |
Card | Number | Required | Positive Integer: Values 1 -2 |
Port Admin Status | List | Optional | Choose – Enabled or Disabled |
Service Admin Status | List | Optional | Choose – Enabled, Disabled, Enabled-no-alarms |
Subscriber ID | String | Optional | |
Description | String | Optional | |
META Group Information | |||
Username | String | Optional | Username to log in to Metaswitch |
Generate Password | String | Optional | Yes or No. If no, populate the password field. If yes, populate the password seed field |
Password Seed | String | Optional* | Required if Generate Password = Yes. The system will generate a random password based on the seed value. Recommend using a variable value like InternalObjectID. Seed value should be the same in Calix as Metaswitch. |
Password | String | Optional* | Enter Password |
URI | String | Required | Must match the value in Metaswitch. |
Service Information | |||
Voice Port | Number | Required | Positive Integer |
SIP Profile | Number | Optional | Default value or create a custom list. |
Dial Plan | Number | Optional | |
Call Waiting | String | Optional | “true” or “false”. Default value is “false” |
Caller ID | String | Optional | “true” or “false”. Default value is “false” |
Three Way Calling | String | Optional | “true” or “false”. Default value is “false” |
T38 Fax Relay | String | Optional | “true” or “false”. Default value is “false” |
Message Waiting Indicator | String | Optional | “true” or “false”. Default value is “false” |
*Field is conditionally required. The selection of specific values in preceding fields may change the field from option to required.