Provisioning – Calix SMx Specifications and Actions

Summary

This article describes the certified specifications IDI provisioning supports for Calix SMx. Provisioning currently supports a subset of the Calix SMx provisioning capabilities. This article contains a detailed list of actions and parameters.

Specifications

Provider: Calix SMx

Link: https://www.calix.com/

Application Interface: Service Management Connector (SMx)

Application Version: R24.x Northbound Interface

CalixSMx Provider Version: 1.0

Bundle Version: 25.5

Certified Platforms: XGPON Service

Overview

The section below describes how Provisioning interacts with Calix SMx APIs and offers helpful advice and guidelines.

SMx functionally is based around the Subscriber, meaning that Services start with the subscriber and all aspects of the service can be referenced by that subscriber.
Parameters will only display as required if they’re required for every call. Optional fields that do not contain a value will not be displayed. 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 SMx include:

Provider	Platform	Action	Available
Calix SMx	XGPON	Create/Update ONT	25.5
Calix SMx	XGPON	Reset ONT	25.5
Calix SMx	XGPON	Delete ONT	25.5
Calix SMx	XGPON	Update ONT Port Status	25.5
Calix SMx	XGPON	Unlink ONT	25.5
Calix SMx	XGPON	Create/Update Subscriber	25.5
Calix SMx	XGPON	Delete Subscriber	25.5
CalixSMx	XGPON	Create/Update Data Service	25.5
Calix SMx	XGPON	Delete Data Service	25.5
Calix SMx	XGPON	Pause/Resume Data Service	25.5
Calix SMx	XGPON	Create/Update Voice Service	25.5
Calix SMx	XGPON	Delete Voice Service	25.5
Calix SMx	XGPON	Pause/Resume Voice Service	25.5

Action Detail for XGPON Services

The section below describes the available parameters and supported actions for provisioning XGPON services.

Create/Update ONT

The action defines the objects required to create or update ONT on XGPON ethernet ports.

When Add-Update Mode is set to:

Add/Update – This action will be a POST, if there is an error, try with Action set to PUT, then return any error that occurs
Add-Only – This action will be a POST, return any error that occurs.
Update-Only – This action will be a PUT, return any error that occurs.

There are two options for ONT ID fields:

Enter ONT ID in the ONT ID parameter.
Have the system generate a random ONT ID using the ‘Auto-Generate’ parameter.
If the Auto-Generate parameter is set to True, it will send AutoGenerateID
If the Auto-Generate parameter is set to False, it will send the ONT ID

AvailableParameters

Name	Type	Required	Notes
Add-UpdateMode
Add-Update Mode	List/String	Required	Add-Only, Update-Only, Add/Update
ConnectionInformation
Address	String	Required	URL of the Calix SMx WS
Username	String	Required	Username for Authentication
Password	String	Required	Password for Authentication
GeneralInformation
OLT	String	Required
ONT ID	String	Required
Auto-Generate	Boolean	Optional	True or False
Is Global ONT	Boolean	Optional
ONT Template	String	Optional
Type	List/String	Required	Residential or IBONT
ONT Type	List/String	Required	Local or Global
Subscriber ID	String	Optional
ONT Profile ID	String	Required
Registration ID	String	Required
Serial Number	String	Required
Location	String	Optional
ONT Description	String	Optional
Vendor ID	String	Optional

Reset ONT

The action lets administrators reset an ONT.

AvailableParameters

Name	Type	Required	Notes
ConnectionInformation
Address	String	Required	URL of the Calix SMx WS
Username	String	Required	Username for Authentication
Password	String	Required	Password for Authentication
GeneralInformation
OLT	String	Required
ONT ID	String	Optional
Serial Number	String	Optional
Forced	String	Optional

Delete ONT

The action defines the objects required to Delete ONTs.

Available Parameters

Name	Type	Required	Notes
ConnectionInformation
Address	String	Required	URL of the Calix SMx WS
Username	String	Required	Username for Authentication
Password	String	Required	Password for Authentication
GeneralInformation
OLT	String	Required
ONT ID	String	Optional
Serial Number	String	Optional

Update ONT Port Status

The action defines the objects required to update XGPON Ports for data or voice services.

AvailableParameters

Name	Type	Required	Notes
ConnectionInformation
Address	String	Required	URL of the Calix SMx WS
Username	String	Required	Username for Authentication
Password	String	Required	Password for Authentication
GeneralInformation
OLT	String	Required
ONT ID	String	Required
Port	String	Required
Admin Status	List/String	Required	up or down

Unlink ONT

The action defines the objects required to unlink the old ONT.

Available Parameters

Name	Type	Required	Notes
ConnectionInformation
Address	String	Required	URL of the Calix SMx WS
Username	String	Required	Username for Authentication
Password	String	Required	Password for Authentication
GeneralInformation
OLT	String	Required
ONT ID	String	Required

Create/Update Subscriber

The action defines the objects required to create or update the Subscriber.

AvailableParameters

Name	Type	Required	Notes
Add-UpdateMode
Add-Update Mode	List/String	Required	Add-Only, Update-Only, Add/Update
ConnectionInformation
Address	String	Required	URL of the Calix SMx WS
Username	String	Required	Username for Authentication
Password	String	Required	Password for Authentication
GeneralInformation
Account Number	String	Required
First Name	String	Optional
Last Name	String	Optional
Org ID	String	Optional	Default = Calix
Primary ContactInformation
Phone Number	String	Optional
Email Address	String	Optional
PrimaryStreetAddress
Street Line 1	String	Optional
City	String	Optional
State	String	Optional
Zip/Postal Code	String	Optional
Country	String	Optional

Delete Subscriber

The action defines the objects required to delete the Subscriber.

AvailableParameters

Name	Type	Required	Notes
ConnectionInformation
Address	String	Required	URL of the Calix SMx WS
Username	String	Required	Username for Authentication
Password	String	Required	Password for Authentication
GeneralInformation
Org ID	String	Required	Default = Calix
Account Number	String	Required

Create/Update Data Service

The action defines the objects required to create or update the data service on XGPON ethernet ports.

When Add-Update Mode is set to:

Add/Update – This action will be a POST, if there is an error, try with Action set to PUT, then return any error that occurs
Add-Only – This action will be a POST, return any error that occurs.
Update-Only – This action will be a PUT, return any error that occurs.

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 SMx.

AvailableParameters

Name	Type	Required	Notes
Add-UpdateMode
Add-Update Mode	List/String	Required	Add-Only, Update-Only, Add/Update
ConnectionInformation
Address	String	Required	URL of the Calix SMx WS
Username	String	Required	Username for Authentication
Password	String	Required	Password for Authentication
General Information
Account Number	String	Required
OLT	String	Required
ONT ID	String	Required
Service Information
Service Type	String	Optional
ONT Port ID	String	Required
Port Description	String	Optional
Service Name	String	Required
Service Description	String	Optional
Policy Map	String	Optional
VLAN	Number	Optional
c-VLAN	Number	Optional
Admin State	String	Required
Admin Status	String	Optional
PON-COS	String	Optional
L2 Match	Number	Optional
Egress Shaper Max	Number	Optional
Ingress Meter EIR	String	Optional
DHCP Lease	Number	Optional
Option82 Action	String	Optional
PON Upstream Profile	String	Optional
Static IPInformation
IP Address	String	Optional
MAC	String	Optional
Gateway 1	String	Optional
Gateway 2	String	Optional
Gateway 3	String	Optional

Delete Data Service

The action defines the objects required to delete the data service on XGPON ethernet ports.

Available Parameters

Name	Type	Required	Notes
ConnectionInformation
Address	String	Required	URI of the Calix SMx WS
Username	String	Required	Username for Authentication
Password	String	Required	Password for Authentication
GeneralInformation
OLT	String	Required
ONT ID	String	Required
ONT Port ID	String	Required
Service Name	String	Required

Pause/Resume Data Service

The action defines the objects required to pause or resume the data service on XGPON ethernet ports.

The Action field indicates if you want to pause or resume the data service.

Available Parameters

Name	Type	Required	Notes
ConnectionInformation
Address	String	Required	URL of the Calix SMx WS
Username	String	Required	Username for Authentication
Password	String	Required	Password for Authentication
GeneralInformation
OLT	String	Required
ONT ID	String	Required
ONT Port ID	String	Required
VLAN ID	Number	Required
C-Tag	Number	Optional
Action	List/String	Required	Resume, Pause

Create/Update Voice Service

The action defines the objects required to create or update the voice service on XGPON ethernet ports.

When Add-Update Mode is set to:

Add/Update – This action will be a POST, if there is an error, try with Action set to PUT, then return any error that occurs
Add-Only – This action will be a POST, return any error that occurs.
Update-Only – This action will be a PUT, return any error that occurs.

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.

AvailableParameters

Name	Type	Required	Notes
Add-UpdateMode
Add-Update Mode	List/String	Required	Add-Only, Update-Only, Add/Update
ConnectionInformation
Address	String	Required	URL of the Calix SMx WS
Username	String	Required	Username for Authentication
Password	String	Required	Password for Authentication
GeneralInformation
Account Number	String	Required
OLT	String	Required
ONT ID	String	Required
ServiceInformation
Service Type	String	Optional
ONT Port ID	String	Required
Port Description	String	Optional
Service Name	String	Required
Service Description	String	Optional
Policy Map	String	Optional
VLAN	Number	Optional
c-VLAN	Number	Optional
Admin State	String	Required
Admin Status	String	Optional
SIP Profile	String	Optional
SIP URI	String	Optional
SIP User	String	Optional
SIP Password	String	Optional
Generate Password	Boolean	Optional
Password Seed	String	Optional
Dial Plan	String	Optional
Call Waiting	Boolean	Optional
Caller ID	Boolean	Optional
Three Way Calling	Boolean	Optional
T38 Fax Relay	Boolean	Optional
MSG Waiting Indicator	Boolean	Optional
Direct Connect	String	Optional
Direct Connect Timer	Number	Optional
GR-303	Boolean	Optional
DHCP Lease Limit	Number	Optional
MGCP Profile	String	Optional
Ingress Meter EIR	String	Optional
Egress Shaper Max	Number	Optional

Delete Voice Service

The action defines the objects required to delete the voice service on XGPON ethernet ports.

Available Parameters

Name	Type	Required	Notes
ConnectionInformation
Address	String	Required	URL of the Calix SMx WS
Username	String	Required	Username for Authentication
Password	String	Required	Password for Authentication
GeneralInformation
OLT	String	Required
ONT ID	String	Required
ONT Port ID	String	Required
Service Name	String	Required

Pause/Resume Voice Service

The action defines the objects required to pause or resume the voice service on XGPON ethernet ports.

The Action field indicates if you want to pause or resume the voice service.

Available Parameters

Name	Type	Required	Notes
ConnectionInformation
Address	String	Required	URL of the Calix SMx WS
Username	String	Required	Username for Authentication
Password	String	Required	Password for Authentication
GeneralInformation
OLT	String	Required
ONT ID	String	Required
ONT Port ID	String	Required
VLAN ID	Number	Required
C-Tag	Number	Optional
Action	List/String	Required	Resume, Pause

Documentation Index

Provisioning – Calix SMx Specifications and Actions

Summary

Specifications

Overview

Available Actions:

Action Detail for XGPON Services

Create/Update ONT

Reset ONT

Delete ONT

Update ONT Port Status

Unlink ONT

Create/Update Subscriber

Delete Subscriber

Create/Update Data Service

Delete Data Service

Pause/Resume Data Service

Create/Update Voice Service

Delete Voice Service

Pause/Resume Voice Service