fabric.license_policy

LicPolicy class represents license policy encapsulates user’s configuration data used in smart licensing management. Because user’s configuration data shall support export/import, the owner of LicensePolicy is PM.

ACI class

licenseLicPolicy

RN

licensepol

Cursor

LicensePolicyCursor

Parent

fabric

Atomic

Attributes

Accepted as keyword arguments of .license_policy() and of .set(**attrs) on this cursor. Enum parameters also accept the plain string.

parameter

wire

type

values

default

description

action_result

actionResult

LicenseActionResult

create-rum-report-failure, create-rum-report-success, none

none

actionResult is to indicate whether or not RUM report download or Acknowledgement import is succeeded or failed.

authorization_code

authCode

str

Authorization code or permanent license installed by user.

certificate

cert

str

force_re_register

forceRegister

bool

False

To force re-register the product with CSSM, regardless whether or not the product is alread registered. Per ELO requirement, let user decide if he/she wants to force re-register. If forceRegister = false, SA returns an error if the product is already registered.

hostname_privacy

hostnamePrivacy

bool

False

ip_addr

ipAddr

str

For Call Home HTTP proxy server

smart_licensing_action

licenseAction

LicenseLicActionType

create-rum-report, device-led-conversion, disable-dev-cert, enable-dev-cert, import-private-certificate, install-rum-report-ack, modify-report-interval, none, remove-private-certificate, renew-id-cert, renew-license-auth, show-license-all, show-license-status, show-license-summary, show-license-tech-support, show-license-udi, show-license-usage, test-expire-ack-deadline, test-expire-auth, test-expire-auth-renew, test-expire-eval, test-expire-eval-warn, test-expire-idcert, test-expire-idcert-renew, test-expire-registration, test-expire-reservation, test-plr-auth-failed, test-plr-cancel, test-plr-install, test-plr-return

none

Action for manually renewing ID certificate, license authorization and so on. Based on action enum type, corresponding SA API is invoked and SA return a formatted long string encapsulating the data.

license_sync_freq

licenseSyncFreq

int

60

smart_license_mode

mode

LicenseLicenseMode

cslu, offline, plr, proxy, satellite, smart-licensing, transport-gateway

smart-licensing

Smart licensing mode.

plr_admin_state

plrAdminState

LicensePlrAdminState

cancel, install, none, request, return, return-auth

none

Admin state for triggering request/cancel/install/return reservation action.

proxy_server_port

port

int

443

The port number of third-party HTTP/HTTPs proxy server. When the mode is not proxy, port is not required and can be ignored.

smart_licensing_admin_state

regAdminState

LicenseRegAdminState

deregister, none, register

none

Admin state for triggering registration and unregistration.

product_instance_id_token

regTokenId

str

To register product with CSSM, a user need to input registration token ID. The registration token ID is created by customer from CSSM web site.

report_interval

reportInterval

int

30

SLE policy allows a user to change license reporting interval. Default value is 30 days, and min and max range is 1 - 90 days.

url

url

str

The url of remote manager (CSSM, Satellite manager or SCH gateway server). When the mode is plr, url is not required and can be ignored.