Table Of Contents
Helper Modules
Cisco::CLM::Common::AuditTrail
Cisco::CLM::Common::CountInfo
Cisco::CLM::Common::Device
Cisco::CLM::Common::DeviceAuthentication
Cisco::CLM::Common::DeviceFilter
Cisco::CLM::Common::DevicePlatformInfo
Cisco::CLM::Common::DeviceStatus
Cisco::CLM::Common::DeviceStatusItem
Cisco::CLM::Common::DiscoveryAuthInfo
Cisco::CLM::Common::EulaInfo
Cisco::CLM::Common::ExpiredLicense
Cisco::CLM::Common::ExpiryInfo
Cisco::CLM::Common::FeatureInfo
Cisco::CLM::Common::Group
Cisco::CLM::Common::GroupStatus
Cisco::CLM::Common::GroupStatusItem
Cisco::CLM::Common::IDStatus
Cisco::CLM::Common::IDStatusItem
Cisco::CLM::Common::IpMask
Cisco::CLM::Common::License
Cisco::CLM::Common::LicenseLine
Cisco::CLM::Common::LicenseLineInfo
Cisco::CLM::Common::LicenseRequest
Cisco::CLM::Common::LicenseStatus
Cisco::CLM::Common::LicenseStatusItem
Cisco::CLM::Common::LicLineStatus
Cisco::CLM::Common::LicLineStatusItem
Cisco::CLM::Common::Notification
Cisco::CLM::Common::PAK
Cisco::CLM::Common::PAKStatus
Cisco::CLM::Common::PAKStatusItem
Cisco::CLM::Common::Policy
Cisco::CLM::Common::PolicyStatus
Cisco::CLM::Common::RehostableSKU
Cisco::CLM::Common::RehostableSKUStatus
Cisco::CLM::Common::RehostInfo
Cisco::CLM::Common::RehostInfoStatus
Cisco::CLM::Common::RehostInfoStatusItem
Cisco::CLM::Common::RehostRequest
Cisco::CLM::Common::ReportStatus
Cisco::CLM::Common::Schedule
Cisco::CLM::Common::SKU
Cisco::CLM::Common::SKUFilter
Cisco::CLM::Common::SKUIdentifier
Cisco::CLM::Common::Status
Cisco::CLM::Common::UsageInfo
Cisco::CLM::Common::UserInfo
Cisco::CLM::Common::UserPwd
Cisco::CLM::Common::UserToken
Cisco::CLM::Common::XRSlotInfo
Helper Modules
The data objects needed by the core API have been defined as a set of modules. Each module has the corresponding get and set methods defined to access or set the values of the variables in that module. The helper modules are as follows:
•
Cisco::CLM::Common::AuditTrail
•Cisco::CLM::Common::CountInfo
•Cisco::CLM::Common::Device
•Cisco::CLM::Common::DeviceAuthentication
•Cisco::CLM::Common::DeviceFilter
•Cisco::CLM::Common::DevicePlatformInfo
•Cisco::CLM::Common::DeviceStatus
•Cisco::CLM::Common::DeviceStatusItem
•Cisco::CLM::Common::DiscoveryAuthInfo
•Cisco::CLM::Common::EulaInfo
•Cisco::CLM::Common::ExpiredLicense
•Cisco::CLM::Common::ExpiryInfo
•Cisco::CLM::Common::FeatureInfo
•Cisco::CLM::Common::Group
•Cisco::CLM::Common::GroupStatus
•Cisco::CLM::Common::GroupStatusItem
•Cisco::CLM::Common::IDStatus
•Cisco::CLM::Common::IDStatusItem
•Cisco::CLM::Common::IpMask
•Cisco::CLM::Common::License
•Cisco::CLM::Common::LicenseLine
•Cisco::CLM::Common::LicenseLineInfo
•Cisco::CLM::Common::LicenseRequest
•Cisco::CLM::Common::LicenseStatus
•Cisco::CLM::Common::LicenseStatusItem
•Cisco::CLM::Common::LicLineStatus
•Cisco::CLM::Common::LicLineStatusItem
•Cisco::CLM::Common::Notification
•Cisco::CLM::Common::PAK
•Cisco::CLM::Common::PAKStatus
•Cisco::CLM::Common::PAKStatusItem
•Cisco::CLM::Common::Policy
•Cisco::CLM::Common::PolicyStatus
•Cisco::CLM::Common::RehostableSKU
•Cisco::CLM::Common::RehostableSKUStatus
•Cisco::CLM::Common::RehostInfoStatus
•Cisco::CLM::Common::RehostInfoStatusItem
•Cisco::CLM::Common::RehostRequest
•Cisco::CLM::Common::ReportStatus
•Cisco::CLM::Common::Schedule
•Cisco::CLM::Common::SKU
•Cisco::CLM::Common::SKUFilter
•Cisco::CLM::Common::SKUIdentifier
•Cisco::CLM::Common::Status
•Cisco::CLM::Common::UsageInfo
•Cisco::CLM::Common::UserInfo
•Cisco::CLM::Common::UserPwd
•Cisco::CLM::Common::UserToken
•Cisco::CLM::Common::XRSlotInfo
Cisco::CLM::Common::AuditTrail
This module defines the AuditTrail methods.
Method
|
Parameters
|
Return Value
|
Description
|
get_user
|
None
|
String
|
Returns the user
|
get_start_time
|
None
|
Time in milliseconds since the start of the epoch
|
Returns the start time of an operation
|
get_end_time
|
None
|
Time in milliseconds since the start of the epoch
|
Returns the end time of an operation
|
get_operation
|
None
|
String
|
Returns the operation
|
get_operation_status
|
None
|
One of the following
Cisco::CLM::Common::AuditTrail::OperationStatus values:
SUCCESS, FAILURE
|
Returns the operation status
|
get_message
|
None
|
String
|
Returns the message
|
get_affected
|
None
|
String
|
Returns affected task
|
get_id
|
None
|
String
|
Returns the ID
|
Cisco::CLM::Common::CountInfo
This module defines the CountInfo.
Method
|
Parameters
|
Return Value
|
Description
|
get_total_count
|
None
|
Integer
|
Returns the total count
|
set_total_count($count)
|
Integer
|
None
|
Sets the total count
|
get_usage_count
|
None
|
Integer
|
Returns the count in use
|
set_usage_count($count)
|
Integer
|
None
|
Sets the count in use
|
Cisco::CLM::Common::Device
This module defines the methods for getting and setting the variables for a device.
Method
|
Parameters
|
Return Value
|
Description
|
new
|
None
or
String
|
None
|
The new method creates the Device object. It takes either no parameters or the device-id as the parameter
|
get_check_connection_flag
|
None
|
Boolean
|
Returns the connection flag
|
set_check_connection_flag( $val)
|
Boolean
|
None
|
Sets the connection flag
|
get_device_id
|
None
|
String
|
Returns the device id, which is the same as device UDI.
|
get_device_pid
|
None
|
String
|
Returns the device Product ID
|
get_device_vid
|
None
|
String
|
Returns the device Version ID
|
get_device_sn
|
None
|
String
|
Returns the device Serial Number
|
get_ip_addr
|
None
|
String
|
Returns device IP address
|
set_ip_addr($ip_addr)
|
String
|
None
|
Sets device IP address
|
get_udi
|
None
|
String
|
Returns device UDI
|
set_udi($udi)
|
String
|
None
|
Sets device UDI
|
get_hostname
|
None
|
String
|
Returns device hostname
|
set_hostname($hostname)
|
String
|
None
|
Sets device hostname
|
get_display_name
|
None
|
String
|
Returns display name
|
set_display_name($name)
|
String
|
None
|
Sets display name
|
get_device_platform_info
|
None
|
Array of Cisco::CLM::Common::Device ::DevicePlatformInfo
|
Returns the information on all theplatforms for the device
|
add_device_platform_info($info)
|
Cisco::CLM::Common::Device ::DevicePlatform
|
None
|
Adds the device platform information
|
set_device_platform_ info([@info])
|
Array of Cisco::CLM::Common::Device ::DevicePlatform
|
None
|
Sets the information on all the platforms for the device
|
get_device_platform_info_ by_platform($platform)
|
Cisco::CLM::Common::Device ::DevicePlatform
|
Cisco::CLM::Common::Device ::DevicePlatform
|
Returns the platform information for a given platform
|
get_licensable_features
|
None
|
Array of String
|
Returns licensable features
|
get_last_poll_date
|
None
|
String
|
Returns poll date as a string
|
set_last_poll_date($date)
|
Integer
|
None
|
The input parameter is the number of milliseconds sinc the epoch
|
get_last_poll_status
|
None
|
One of the following
Cisco::CLM::Common::Device::PollStatus::
FAILURE
Cisco::CLM::Common::Device::PollStatus::
SUCCESS
|
Returns poll status
|
set_last_poll_status($status)
|
One of the following
Cisco::CLM::Common::Device::PollStatus::
FAILURE
Cisco::CLM::Common::Device::PollStatus::
SUCCESS
|
None
|
Sets poll status
|
get_poll_by_user
|
None
|
String
|
Returns polled_by info
|
set_poll_by_user($user)
|
String
|
None
|
Sets polled_by info
|
get_member_dev_ids
|
None
|
Array of String
|
Returns the child devices' ids, applicable to master device in stackable device
|
set_member_dev_ids([@dev_ids])
|
Array of String
|
None
|
Sets the member device ids,
applicable to master device in stackable device
|
get_parent_dev_id
|
None
|
String
|
Returns the parent device id,
applicable to child
devices in stackable
devices
|
set_parent_dev_id($parent_id)
|
String
|
None
|
Sets the parent device id, applicable to child
devices in stackable
devices
|
get_credential
|
None
|
String
|
Returns device credential
|
set_credential($cred)
|
String
|
None
|
Sets device credential
|
get_device_model
|
None
|
String
|
Returns device model
|
set_device_model($model)
|
String
|
None
|
Sets device model
|
get_device_type
|
None
|
String
|
Returns device type
|
set_device_type($type)
|
String
|
None
|
Sets device type
|
get_device_access_list
|
None
|
Array of Strings
|
Returns device access list
|
set_device_access_list([@list])
|
Array of String
|
None
|
Sets device access list
|
get_device_state
|
None
|
One of the following
DeviceState values;
Cisco::CLM::Common::Device::DeviceState::
DEV_CONNECT,
DEV_CANNOT_PING,
DEV_CANNOT_AUTHENTICATE,
DEV_CANNOT_CONNECT
|
Returns the device state
|
get_device_swversion
|
None
|
String
|
Returns the software version
|
set_device_swversion($ver)
|
String
|
None
|
Sets the software version
|
get_feature_info
|
None
|
Array of FeatureInfo objects
|
Returns the feature info
|
get_rmaflag
|
None
|
Boolean
|
Returns True if device is rma, false otherwise
|
set_rmaflag($if_rma)
|
Boolean
|
None
|
Sets the RMA
|
get_dirty_flag
|
None
|
Boolean
|
Returns true if device is marked dirty, false otherwise
|
set_dirty_flag($if_dirty)
|
Boolean
|
None
|
Sets the device dirty
|
get_slot
|
None
|
integer
|
Returns the slot # for the device
|
set_slot($num)
|
integer
|
None
|
Sets the slot # for the device
|
add_user_to_device_access_list
|
String
|
Boolean
|
Adds the user to device access list,
returns true if the addition is successful, else false
|
rm_user_from_device_accesslist
|
String
|
Boolean
|
Removes user from the device access list
|
remove_device_access_list
|
none
|
none
|
Resets the device access list to null.
|
Cisco::CLM::Common::DeviceAuthentication
This module defines the methods for getting and setting the device authentication information.
Method
|
Parameters
|
Return Value
|
Description
|
new
|
None
|
None
|
This method creates the DeviceAuthentication object
|
new($user,$password,
$enable_password)
|
String,String,String
|
DeviceAuthentication object
|
This method creates the DeviceAuthentication object with the given input values
|
get_username
|
None
|
String
|
Returns username
|
set_username($username)
|
String
|
None
|
Sets username
|
get_password
|
None
|
String
|
Returns password
|
set_password($passwd)
|
String
|
None
|
Sets password
|
get_enable_password
|
None
|
String
|
Returns enable password for IOS devices
|
set_enable_password($passwd)
|
String
|
None
|
Sets enable password for IOS devices
|
Cisco::CLM::Common::DeviceFilter
This module defines the get and set methods for the device filter used in policy.
Method
|
Parameters
|
Return Value
|
Description
|
new
|
None
|
None
|
This method creates the DeviceFilter object
|
get_type
|
None
|
String
|
Returns the device type
|
set_type($type)
|
String
|
None
|
Sets the device type
|
get_model
|
None
|
String
|
Returns the device model
|
set_model($model)
|
String
|
None
|
Sets the device model
|
get_sw_version
|
None
|
String
|
Returns the software version
|
set_sw_version($version)
|
String
|
None
|
Sets the software version
|
get_group
|
None
|
String
|
Returns the device group
|
set_group($grp)
|
String
|
None
|
Sets the device group
|
get_ip_lower_limit
|
None
|
String
|
Returns the lower limit for IP address
|
set_ip_lower_limit($limit)
|
String
|
None
|
Sets the lower limit for IP address
|
get_ip_upper_limit
|
None
|
String
|
Returns the upper limit for IP address
|
set_ip_upper_limit($limit)
|
String
|
None
|
Sets the upper limit for IP address
|
Cisco::CLM::Common::DevicePlatformInfo
This module defines platform specific information. A device may support different kinds of platform specific licensing. DevicePlatformInfo encapsulates the licensing information per platform type.
Method
|
Parameters
|
Return Value
|
Description
|
new
|
Cisco::CLM::Common::Device::TransportMethod, int
|
None
|
Returns the DevicePlatformInfo object
|
get_connect_state
|
None
|
One of the following:
Cisco::CLM::Common::De
vice::DeviceState::
DEV_CANNOT_AUTHENTICAT
E DEV_CANNOT_CONNECT
DEV_CANNOT_PING
DEV_CONNECT
|
Returns the connection state
|
get_device_access_info
|
None
|
Array of String
|
Returns an array of three strings:
1. The first string gives the transportMethod.
2. The second string gives the license agent 'url.'
3. The third gives the license agent version.
Note If the transport method is telnet/ssh, the second and third strings are null
|
set_device_access_info([@info])
|
Array of String
|
None
|
Sets the device access information
|
get_device_authentication
|
None
|
Cisco::CLM::Common::DeviceAuthentication
|
Returns the DeviceAuthentication object, containing the username/pwd, and enable pwd used for telnet/ssh
|
set_device_authentication([@auth])
|
Cisco::CLM::Common::DeviceAuthentication
|
None
|
Sets the DeviceAuthentication
|
get_device_lic_capabilities
|
None
|
An array of Cisco::CLM::Common::Device::LicenseOperation
|
Returns the licensing operations supported for a device platform
|
set_device_capabilities( [@ops])
|
An array of Cisco::CLM::Common::Device::LicenseOperation
|
None
|
Sets the licensing operations for a device platform
|
get_device_platform
|
None
|
One of the following:
Cisco::CLM::Common::De
vice::DevicePlatform::
CISCO12K
|
Returns the platform
|
set_device_platform($platform)
|
One of the following:
Cisco::CLM::Common::D
evice::DevicePlatform
::
|
None
|
Sets the device platform
|
get_feature_info
|
None
|
Array of Cisco::CLM::Common::FeatureInfo
|
Returns the information for licensable features on the device platform
|
set_feature_info([@features])
|
Array of Cisco::CLM::Common:: FeatureInfo
|
None
|
Sets the information for licensable features on the device platform
|
get_licensable_features
|
None
|
Array of String
|
Returns the features that are licensable
|
set_licensable_features([@features])
|
Array of String
|
None
|
Sets the licensable features
|
get_transport_method
|
None
|
Cisco::CLM::Common:: Device::TransportMethod
|
Returns the transport method associated with the platform
|
set_transport_method($method)
|
Cisco::CLM::Common::Device::TransportMethod
|
None
|
Sets the transport method associated with the platform
|
get_transport_port
|
None
|
integer
|
Returns the port number used by the transport method
|
set_transport_port($port)
|
integer
|
None
|
Sets the port number used by the transport method
|
set_connect_state($state)
|
Cisco::CLM::Common:: Device::DeviceState
|
None
|
Sets the device connection state
|
Cisco::CLM::Common::DeviceStatus
This module gets and sets the DeviceStatusItem list. It inherits all the methods of Cisco::CLM::Common::Status in addition to the ones given below.
Method
|
Parameters
|
Return Value
|
Description
|
get_device_status_items
|
None
|
Array of DeviceStatusItem
|
Returns the DeviceStatusItem list
|
set_device_status_items([@itms])
|
DeviceStatusItem object Array
|
None
|
Sets the DeviceStatusItem list
|
Cisco::CLM::Common::DeviceStatusItem
This module gets and sets the Device object. It inherits all the methods of Cisco::CLM::Common::Status in addition to the ones given below.
Method
|
Parameters
|
Return Value
|
Description
|
get_device
|
None
|
Device object
|
Returns the Device object
|
set_device($dev)
|
Device object
|
None
|
Sets the Device object
|
Cisco::CLM::Common::DiscoveryAuthInfo
This module gets and sets information needed for device discovery.
Method
|
Parameters
|
Return Value
|
Description
|
new(@user_pwd_array,@string_array)
|
Array of UserPwd objects, String Array of enable passwords
|
None
|
Returns the DiscoveryAuthInfo object
|
get_user_pwd_pairs
|
None
|
Array of UserPwd objects
|
Returns the User-password pair.
|
get_enable_passwords
|
None
|
Array of String
|
Returns an array of enable passwords
|
Cisco::CLM::Common::EulaInfo
This module gets and sets the EULA information.
Method
|
Parameters
|
Return Value
|
Description
|
new($accepted,$do_no_ask)
|
$accepted - Boolean
$do_not_ask -Boolean
|
None
|
Creates EulaInfo object
|
new
|
None
|
None
|
Creates EulaInfo object
|
get_eula_accepted
|
None
|
Boolean
|
Returns true if EULA is accepted, false otherwise
|
get_do_not_ask_again
|
None
|
Boolean
|
Returns true/false
|
set_do_not_ask_again($val)
|
Boolean
|
None
|
Sets the `Do not ask again'
|
get_eula_accepted_time
|
None
|
String
|
Returns the date of eula acceptance
|
get_eula_statement
|
None
|
String
|
Returns the EULA statement
|
set_eula_accepted($val)
|
Boolean
|
None
|
Sets the "Eula Accepted"
|
Cisco::CLM::Common::ExpiredLicense
This module contains information on expired licenses.
Method
|
Parameters
|
Return Value
|
Description
|
get_licline_ids
|
None
|
Array of String
|
Returns an array of license line ids.
|
get_device_id
|
None
|
String
|
Returns the device id
|
get_feature_name
|
None
|
String
|
Returns the feature name
|
get_feature_version
|
None
|
String
|
Returns the feature version
|
Cisco::CLM::Common::ExpiryInfo
This module contains the expiration information of license line.
Method
|
Parameters
|
Return Value
|
Description
|
new
|
None
|
None
|
Returns the ExpiryInfo object
|
get_expire_type
|
None
|
Cisco::CLM::Common::LicenseLine::LLExpireType::
DAY_BASE,
DATE_BASE
|
Returns the expiry type of the license line
|
set_expiry_type($type)
|
Cisco::CLM::Common::LicenseLine::LLExpireType::
DAY_BASE,
DATE_BASE
|
None
|
Sets the expiry type of the license line
|
get_expire_days
|
None
|
Integer
|
Returns the number of days to expire for DAY_BASE
|
set_expire_days($days)
|
Integer
|
None
|
Sets the number of days for expiry
|
get_start_day
|
None
|
String
|
Returns the start date for DATE_BASE
|
set_start_day($date)
|
Integer
|
None
|
Sets the start date, the date parameter is an integer representing the number of milliseconds since the epoch
|
get_end_day
|
None
|
String
|
Returns the end date as a String for DATE_BASE
|
set_end_day($date)
|
Integer
|
None
|
Sets the end date, the date parameter is an integer representing the number of milliseconds since the epoch
|
get_expire_days_from_last_poll
|
None
|
Integer
|
Returns the number of days to expire from the last poll
|
set_expire_days_from_last_poll($days)
|
Integer
|
None
|
Sets the number of days to expire from the last poll
|
Cisco::CLM::Common::FeatureInfo
This module contains the feature information.
Method
|
Parameters
|
Return Value
|
Description
|
new
|
None
|
None
|
Creates the FeatureInfo object
|
get_lic_line_info_list
|
None
|
Array of LicenseLineInfo objects
|
Returns an Array of LicenseLineInfo objects
|
get_total_expiry_usage
|
None
|
Integer
|
Returns the total expiry-usage for the license lines, the value is in milliseconds
|
set_total_expiry_usage($usage)
|
Integer
|
None
|
Sets the expiry_usage
|
get_feature_count_info
|
None
|
Cisco::CLM::Common:: CountInfo
|
Returns the count information for the feature
|
set_feature_count_info($count)
|
Cisco::CLM::Common:: CountInfo
|
None
|
Sets the count information for the feature
|
get_feature_name
|
None
|
String
|
Returns the feature name
|
set_feature_name($name)
|
String
|
None
|
Sets the feature name
|
get_feature_version
|
None
|
String
|
Returns the feature version
|
set_feature_version($ver)
|
String
|
None
|
Sets the feature version
|
get_slot_info
|
None
|
Cisco::CLM::Common:: XRSlotInfo
|
Returns the slot information for an XR device
|
set_slot_info([@info])
|
Cisco::CLM::Common:: XRSlotInfo
|
None
|
Sets the slot information for an XR device
|
get_usage_info
|
None
|
Cisco::CLM::Common:: UsageInfo
|
Returns the usage information for the feature
|
set_usage_info($info)
|
Cisco::CLM::Common:: UsageInfo
|
None
|
Sets the usage information for the feature
|
Cisco::CLM::Common::Group
This module defines a group and its access list.
Method
|
Parameters
|
Return Value
|
Description
|
new($name)
|
String
|
None
|
Creates the group object with specified name
|
get_group_name
|
None
|
String
|
Returns group name
|
get_devices
|
None
|
Array of String
|
Returns the devices associated with a group
|
get_group_access_list
|
None
|
Array of String
|
Returns the access-list for the group
|
set_devices([@devices])
|
Array of String
|
None
|
Sets the devices associated with a group
|
add_user_to_group_access_list($user)
|
String
|
Boolean
|
Returns Boolean true if addition is successful, Boolean false otherwise
|
rm_user_from_group_access_list($user)
|
String
|
Boolean
|
Returns Boolean true if removal is a success, Boolean false otherwise
|
remove_group_access_list
|
None
|
None
|
Resets the group access list
|
Cisco::CLM::Common::GroupStatus
This module defines the get and set methods to access GroupStatusItem list. It inherits all the methods of Cisco::CLM::Common::Status in addition to the ones given below.
Method
|
Parameters
|
Return Value
|
Description
|
get_group_status_items
|
None
|
Array of GroupStatusItem
|
Returns the list of GroupStatusItem
|
set_group_status_items([@list])
|
Array of GroupStatusItem
|
None
|
Sets the list
|
Cisco::CLM::Common::GroupStatusItem
This module defines the get and set methods to access Group. It inherits all the methods of Cisco::CLM::Common::Status in addition to the ones given below.
Method
|
Parameters
|
Return Value
|
Description
|
get_group
|
None
|
Group object
|
Returns Group object
|
set_group($grp)
|
Group object
|
None
|
Sets the Group object
|
Cisco::CLM::Common::IDStatus
This module defines the get and set methods for IDStatusItem. It inherits all the methods of Cisco::CLM::Common::Status in addition to the ones given below.
Method
|
Parameters
|
Return Value
|
Description
|
get_ID_status_items
|
None
|
Array of IDStatusItem
|
Returns an array of IDStatusItem
|
set_ID_status_items(@list)
|
Array of IDStatusItem
|
None
|
Sets the IDStatusItem list
|
Cisco::CLM::Common::IDStatusItem
This module defines the get and set methods for request ID. It inherits all the methods of Cisco::CLM::Common::Status in addition to the ones given below.
Method
|
Parameters
|
Return Value
|
Description
|
get_id
|
None
|
String
|
Returns the request ID
|
set_id($id)
|
String
|
None
|
Sets the request ID
|
Cisco::CLM::Common::IpMask
This module defines the data structure for storing IP Address and the subnet mask.
Method
|
Parameters
|
Return Value
|
Description
|
new
|
None
|
None
|
Creates IpMask object
|
get_ip
|
None
|
String
|
Returns the IP address
|
set_ip($ip)
|
String
|
None
|
Sets the IP address
|
get_mask
|
None
|
String
|
Returns the subnet mask
|
set_mask($mask)
|
String
|
None
|
Sets the subnet mask
|
Cisco::CLM::Common::License
This module gets and sets the information of an obtained license.
Method
|
Parameters
|
Return Value
|
Description
|
new ($id)
|
None
or
String
|
None
|
Creates the License object.
Parmeter can be null or the licenseID
|
get_license_id
|
None
|
String
|
Returns license id which is db key. This is set by CLM server
|
get_feature_names
|
None
|
Array of String
|
Returns the feature names contained in the license
|
set_feature_names([@name])
|
Array of String
|
None
|
Sets the feature names associated with the license
|
get_feature_versions
|
None
|
Array of String
|
Returns the versions of the features
|
set_feature_versions([@ver])
|
Array of String
|
None
|
Sets the feature versions
|
get_lic_file_name
|
None
|
String
|
Returns the license file name
|
set_lic_file_name($name)
|
String
|
None
|
Sets the license file name
|
get_device_id
|
None
|
String
|
Returns the device id
|
set_device_id($dev_id)
|
String
|
None
|
Sets the device id
|
get_obtain_date
|
None
|
String
|
Returns the obtain date for the license
|
set_obtain_date($date)
|
Integer
|
None
|
Sets the obtain date, the date is entered as the number of milliseconds since the epoch
|
get_obtain_source
|
None
|
One of the following Cisco::CLM::Common::License
::ObtainSource values-
CISCO
PREINSTALL
UNKNOWN
|
Returns the source from which the license was obtained
|
set_obtain_source($source)
|
One of the following Cisco::CLM::Common::License
::ObtainSource values-
CISCO
PREINSTALL
UNKNOWN
|
None
|
Sets the source from which the license was obtained
|
get_obtain_by
|
None
|
String
|
Returns the user who obtained the license
|
set_obtain_by($user)
|
String
|
None
|
Sets the user who obtained the license
|
get_deploy_status
|
None
|
One of the following Cisco::CLM::Common::License
::DeployStatus values:
DEPLOYED
UNDEPLOYED
PARTIALLY_ DEPLOYED
|
Returns the deploy status of the license
|
set_deploy_status($status)
|
One of the following Cisco::CLM::Common::License
::DeployStatus values:
DEPLOYED
UNDEPLOYED
PARTIALLY_ DEPLOYED
|
None
|
Sets the deploy status of the license
|
get_lic_line_ids
|
None
|
Array of String
|
Returns the license lines contained in the license
|
set_lic_line_ids([@id])
|
Array of String
|
None
|
Sets the license lines in the license
|
get_pak_id
|
None
|
String
|
Returns the PAK id of which this license is a part
|
set_pak_id($id)
|
String
|
None
|
Sets the PAK id
|
Cisco::CLM::Common::LicenseLine
This module defines the license line.
Method
|
Parameters
|
Return Value
|
Description
|
new
|
String
|
None
|
Creates the LicenseLine object, requires licenselineID as input parameter
|
get_license_id
|
None
|
String
|
Returns license id of the license with which this licenseline is associated
|
set_license_id($id)
|
String
|
None
|
Sets the license id
|
get_license_line_id
|
None
|
String
|
Returns license line id, this is set by CLM server
|
set_license_line_id($id)
|
String
|
None
|
Sets the licenseline id
|
get_feature_name
|
None
|
String
|
Returns the feature name for which this licenseline is obtained
|
set_feature_name($name)
|
String
|
None
|
Sets the feature name associated with the licenseline
|
get_license_line_xml
|
None
|
String
|
Returns the license xml file
|
set_license_line_xml($xml)
|
String
|
None
|
Sets the license xml file
|
get_pak_id
|
None
|
String
|
Returns the PAK id of which this licenseline is a part
|
set_pak_id($id)
|
String
|
None
|
Sets the PAK id
|
get_udi
|
None
|
String
|
Returns the device udi
|
set_udi($udi)
|
String
|
None
|
Sets the device udi
|
get_sku_name
|
None
|
String
|
Returns SKU name with which this licenseline is associated
|
set_sku_name($name)
|
String
|
None
|
Sets SKU name
|
get_deployed_by
|
None
|
String
|
Returns the user who deployed the licenseline
|
set_deployed_by($name)
|
String
|
None
|
Sets the user name
|
get_state
|
None
|
One of the following
Cisco::CLM::Common::Lic
enseLine::LLState
values:
INACTIVE, ALLOCATED,
AVAILABLE
|
Returns the state of the license line read from the device
|
set_state($state)
|
One of the following
Cisco::CLM::Common::Lic
enseLine::LLState
values:
INACTIVE, ALLOCATED,
AVAILABLE
|
None
|
Sets the state of the license line
|
get_deploy_time
|
None
|
String
|
Returns the deploy date
|
set_deploy_time($date)
|
Integer
|
None
|
Sets the deploy date, the date is input as the number of milliseconds since the epoch
|
get_deploy_status
|
None
|
One of the following
Cisco::CLM::Common::LicenseLine::LLDeployStatus values:
DEPLOYED
UNDEPLOYED
|
Returns the deploy status of the license
|
set_deploy_status($status)
|
One of the following
Cisco::CLM::Common::LicenseLine::LLDeployStatus values:
DEPLOYED
UNDEPLOYED
|
None
|
Sets the deploy status of the license
|
get_device_platform
|
None
|
Cisco::CLM::Common::Device::DevicePlatform
|
Returns the device platform
|
set_device_platform($plat)
|
Cisco::CLM::Common::Device::DevicePlatform
|
None
|
Sets the device platform
|
get_eula_required_flag
|
None
|
Boolean
|
Returns true if EULA is required to install the license
|
set_eula_required_flag($bool)
|
Boolean
|
None
|
Sets the EULA-required value
|
get_is_read_only
|
None
|
Boolean
|
Returns true if the license line is read only, it cannot be deployed
|
set_is_read_only
|
Boolean
|
None
|
Sets the value for read only flag
|
get_type
|
None
|
One of the following:
Cisco::CLM::Common::
LicenseLine::LLType
values: EVALUATION,
EVALUATION_
SUBSCRIPTION,
EXTENSION, EXTENTION_
SUBSCRIPTION,
PAID_SUBSCRIPTION,
PERMANENT, UNKNOWN
|
Returns the licenseline type
|
set_type($type)
|
One of the following:
Cisco::CLM::Common::
LicenseLine::LLType
values: EVALUATION,
EVALUATION_
SUBSCRIPTION,
EXTENSION, EXTENTION_
SUBSCRIPTION,
PAID_SUBSCRIPTION,
PERMANENT, UNKNOWN
|
None
|
Sets the licenseline type
|
get_expire_info
|
None
|
ExpiryInfo object
|
Returns the expiry info for licenseline if this licenseline is an expiry licenseline
|
set_expire_info($info)
|
ExpiryInfo Object
|
None
|
Sets the expiry info for licenseline
|
get_usage_info
|
None
|
UsageInfo object
|
Returns the UsageInfo object
|
set_usage_info($info)
|
UsageInfo object
|
None
|
Sets the UsasgeInfo object
|
get_storage_index
|
None
|
Integer
|
Returns the store index
|
set_storage_index($index)
|
Integer
|
None
|
Sets the store index
|
get_storage_name
|
None
|
String
|
Returns the storage name
|
set_storage_name($name)
|
String
|
None
|
Sets the storage name
|
get_count_info
|
None
|
CountInfo object
|
Returns the CountInfo object, containing information on counted licenses
|
set_count_info($count)
|
CountInfo object
|
None
|
Sets the CountInfo object
|
get_version
|
None
|
String
|
Returns the feature version
|
set_version($ver)
|
String
|
None
|
Sets the feature version
|
get_annoatation
|
None
|
String
|
Returns the comment associated with the LicenseLine
|
set_annotation($comment)
|
String
|
None
|
Sets the comment associated with the LicenseLine
|
Cisco::CLM::Common::LicenseLineInfo
This module gives the license line information on usage, count, deployment status, license line type, and license line state.
Method
|
Parameters
|
Return Value
|
Description
|
Method
|
Parameters
|
Return Value
|
Description
|
new
|
None
|
None
|
Creates the LicenseLineInfo object
|
get_lic_line_id
|
None
|
String
|
Returns the license_line_id
|
set_lic_line_id($id)
|
String
|
None
|
Sets the license line id
|
get_usage_info
|
None
|
UsageInfo object
|
Returns the UsageInfo
|
set_usage_info($info)
|
UsageInfo object
|
None
|
Sets the UsageInfo
|
get_license_type
|
None
|
Cisco::CLM::Common::LicenseLine::LLType which can be:
EVALUATION
EXTENSION
PERMANENT
UNKNOWN
|
Returns the LicenseLine Type
|
set_type($type)
|
Cisco::CLM::Common::LicenseLine::LLType which can be:
EVALUATION
EXTENSION
PERMANENT
UNKNOWN
|
None
|
Sets the LicenseLine Type
|
get_count_info
|
None
|
CountInfo object
|
Returns the countInfo object, containing count information if the licenseline is counted type
|
set_count_info($info)
|
CountInfo object
|
None
|
Sets the countInfo object
|
get_deploy_status
|
None
|
Cisco::CLM::Common::LicenseLine::LLDeployStatus which can be:
DEPLOYED
UNDEPLOYED
|
Returns the deploy status
|
set_deploy_status($status)
|
Cisco::CLM::Common::LicenseLine::LLDeployStatus which can be:
DEPLOYED
UNDEPLOYED
|
None
|
Sets the deploy status
|
get_state
|
None
|
Cisco::CLM::Common::LicenseLine::LLState which can be:
ACTIVE_IN_USE
INACTIVE
ACTIVE_NOT_IN_USE
UNKNOWN
|
Returns the license line state
|
set_state($state)
|
Cisco::CLM::Common::LicenseLine::LLState which can be:
ACTIVE_IN_USE
INACTIVE
ACTIVE_NOT_IN_USE
UNKNOWN
|
None
|
Sets the license line state
|
Cisco::CLM::Common::LicenseRequest
This module is to be used when requesting a license.
Method
|
Parameters
|
Return Value
|
Description
|
new
|
None
|
None
|
Creates the LicenseRequest object
|
get_sku_selection
|
None
|
Array of SKU
|
Returns the SKU's obtained
|
set_sku_selection([@sku])
|
Array of SKU
|
None
|
Sets the SKU
|
get_device_id
|
None
|
String
|
Returns the device id
|
set_device_id($id)
|
String
|
None
|
Sets the device id
|
get_annotation
|
None
|
String
|
Returns the comment
|
set_annotation($comment)
|
String
|
None
|
Sets the request comment
|
Cisco::CLM::Common::LicenseStatus
This module returns the license and its status. It inherits all the methods of Cisco::CLM::Common::Status in addition to the ones given below.
Method
|
Parameters
|
Return Value
|
Description
|
get_license_status_items
|
None
|
Array of LicenseStatusItem
|
Returns the array of licenses and their status
|
set_license_status_items([@items])
|
Array of LicenseStatusItem
|
None
|
Sets the array of licenses and their status
|
Cisco::CLM::Common::LicenseStatusItem
This module returns the license. It inherits all the methods of Cisco::CLM::Common::Status in addition to the ones given below.
Method
|
Parameters
|
Return Value
|
Description
|
get_license
|
None
|
License object
|
Returns the license
|
set_license($lic)
|
License object
|
None
|
Sets the license
|
Cisco::CLM::Common::LicLineStatus
This module returns the license and its status. It inherits all the methods of Cisco::CLM::Common::Status in addition to the ones given below.
Method
|
Parameters
|
Return Value
|
Description
|
get_license_line_status_items
|
None
|
Array of LicenseLineStatusItem
|
Returns the array of license lines and their status
|
set_license_line_status_items(@itms)
|
Array of LicenseLineStatusItem
|
None
|
Sets the array of license lines and their status
|
Cisco::CLM::Common::LicLineStatusItem
This module returns the license. It inherits all the methods of Cisco::CLM::Common::Status in addition to the ones given below.
Method
|
Parameters
|
Return Value
|
Description
|
get_license_line
|
None
|
LicenseLine object
|
Returns the license line
|
set_license_line($lic)
|
LicenseLine object
|
None
|
Sets the license line
|
Cisco::CLM::Common::Notification
This module defines the methods for Notifications.
Method
|
Parameters
|
Return Value
|
Description
|
new
|
None
|
None
|
Creates notification object
|
new($msg, $date)
|
String, integer
|
None
|
Creates Notification object with the given message and date, date is input as the number of milliseconds since the epoch
|
new($msg,$date,$dev_id,$dev_name
$dev_model, $severity, @groups, $operation,$licline_id, $feature_name, $store_name, $store_index, $comment)
|
$msg -String
$date- Date(in milliseconds),
$dev_id-String
$dev_name-String,
$dev_model-String,
$severity - int
@groups- Array of String
$operation - Cisco::CLM::Common::
Notification::Operation,
$licline_id- String
$feature_name- String
$store_name - String
$store_index - int
$comment - String
|
None
|
Creates notification object
|
new($dev_id,$dev_name,$dev_type,
$dev_model,$severity, @groups,
$operation, $licline_id, $store_name,
$store_index, $comment, $feature_name, $msg, $date)
|
$dev_id-String
$dev_name-String,
$dev_type - String,
$dev_model-String,
$severity - int
@groups- Array of String
$operation - Cisco::CLM::Common::
Notification::Operation,
$licline_id- String
$store_name - String
$store_index - int,
$comment - String,
$feature_name- String
$msg -String
$date- Date(in milliseconds),
|
None
|
Creates notification object
|
get_comment
|
None
|
String
|
Returns the comment
|
set_comment($comment)
|
String
|
None
|
Sets the comment
|
get_message
|
None
|
String
|
Returns the message
|
set_message($msg)
|
String
|
None
|
Sets the message
|
get_time_stamp
|
None
|
String
|
Returns the time the notification was sent
|
set_time_stamp($time)
|
String
|
None
|
Sets the notification time stamp
|
get_device_id
|
None
|
String
|
Returns the dev_id of the device associated with the notification
|
set_device_id($id)
|
String
|
None
|
Sets the dev_id
|
get_device_name
|
None
|
String
|
Returns the device name
|
set_device_name($name)
|
String
|
None
|
Sets the device name
|
get_device_type
|
None
|
String
|
Returns the type of the device
|
set_device_type($type)
|
String
|
None
|
Sets the device type
|
get_device_model
|
None
|
String
|
Returns the device model
|
set_device_model($model)
|
String:
|
None
|
Sets the device model
|
get_severity
|
None
|
One of the following
Cisco::CLM::Common::
Notification::Severity
CRITICAL
MAJOR
MINOR
WARNING
INFO
INDETERMINATE
|
Returns the severity levels of notification, using X.733 standard
|
set_severity($severity)
|
One of the following
Cisco::CLM::Common::
Notification::Severity
CRITICAL
MAJOR
MINOR
WARNING
INFO
INDETERMINATE
|
None
|
Sets the serverity levels of notification
|
get_group
|
None
|
Array of String
|
Returns the groups the device is associated with
|
set_group(@grp)
|
Array of String
|
None
|
Sets the groups
|
get_operation
|
None
|
One of the following
Cisco::CLM::Common::Notification::Operation
AGENT_STATE
AGENTOFF
ANNOTATE
CLEAR
CONNECTED
CORRUPT
CORRUPT_NOT_
RECOVERED
CORRUPT_RECOVERED
DEVICE_ADD
DEVICE_DELETE
DISCONNECTED
EULAACCEPTED
EXPIRE
EXPIRED
EXPIRING
INSTALL
JOB_CANCELLED
JOB_FAILED
LOADEXHAUSTED
MISSING
NOT_ENFORCED
REVOKE
|
Returns the operation associated with this notification
|
set_operation($op)
|
One of the following
Cisco::CLM::Common::
Notification::Operation: AGENT_STATE
AGENTOFF
ANNOTATE
CLEAR
CONNECTED
CORRUPT
CORRUPT_NOT_
RECOVERED
CORRUPT_RECOVERED
DEVICE_ADD
DEVICE_DELETE
DISCONNECTED
EULAACCEPTED
EXPIRE
EXPIRED
EXPIRING
INSTALL
JOB_CANCELLED
JOB_FAILED
LOADEXHAUSTED
MISSING
NOT_ENFORCED
REVOKE
|
None
|
Sets the operation associated with this notification
|
get_lic_line_id
|
None
|
String
|
Returns the licenseline id
|
set_lic_line_id($id)
|
String
|
None
|
Sets the licenseline id
|
get_feature_name
|
None
|
String
|
Returns the feature name
|
set_feature_name($name)
|
String
|
None
|
Sets the feature name
|
get_store_index
|
None
|
Integer
|
Returns the store index
|
set_store_index($index)
|
Integer
|
None
|
Sets the store index
|
get_store_name
|
None
|
String
|
Returns the store name
|
set_store_name($name)
|
String
|
None
|
Sets the store name
|
Cisco::CLM::Common::PAK
This module defines the characteristics of a PAK.
Method
|
Parameters
|
Return Value
|
Description
|
new($pak_name, $owner)
|
String,String
|
None
|
Creates a PAK object with given pak_name and owner
|
get_pak_id
|
None
|
String
|
Returns the encrypted internal pak id
|
set_pak_id($id)
|
String
|
None
|
Sets the internal id
|
get_pak_name
|
None
|
String
|
Returns the pak name
|
set_pak_name($pak)
|
String
|
None
|
Sets the pak name
|
get_sku_list
|
None
|
Array of SKU
|
Returns the SKUs contained in the pak
|
set_sku_list([@list])
|
Array of SKU
|
None
|
Sets the SKUs contained in the PAK
|
get_last_dnld_date
|
None
|
String
|
Returns the date of last download of PAK
|
set_last_dnld_date($date)
|
Integer
|
None
|
Sets the date of last download of PAK, date is input as the number of milliseconds since the epoch
|
get_dnld_status
|
None
|
Integer
|
Returns the last download status
|
set_dnld_status($status)
|
Integer
|
None
|
Sets the last download status
|
get_dnld_by
|
None
|
String
|
Returns the user who downloaded the PAK
|
set_dnld_by($user)
|
String
|
None
|
Sets the user who downloaded the PAK
|
get_pak_type
|
None
|
String
|
Returns the PAK type
|
set_pak_type($type)
|
String
|
None
|
Sets the PAK type
|
get_pak_owner
|
None
|
String
|
Returns the username who created the PAK
|
get_pak_display_name
|
None
|
String
|
Returns the display name of PAK
|
set_pak_display_name($name)
|
String
|
None
|
Sets the display name of PAK
|
get_pak_access_list
|
None
|
Array of String
|
Returns the access list for the PAK
|
add_user_to_pak_access_list($user)
|
String
|
Boolean
|
Adds the user to the PAK access list
|
rm_user_from_pak_access_list($user)
|
String
|
Boolean
|
Removes the user from PAK access list
|
Cisco::CLM::Common::PAKStatus
This module gets and sets the PAKStatusItem list. It inherits all the methods of Cisco::CLM::Common::Status in addition to the ones given below.
Method
|
Parameters
|
Return Value
|
Description
|
get_pak_status_items
|
None
|
PAKStatusItem array
|
Returns PAKStatusItem array containing PAKs and their status
|
set_pak_status_items(@items)
|
PAKStatusItem array
|
None
|
Sets the PAKStatusItem array containing PAKs and their status
|
Cisco::CLM::Common::PAKStatusItem
This module gets and sets the PAK. It inherits all the methods of Cisco::CLM::Common::Status in addition to the ones given below.
Method
|
Parameters
|
Return Value
|
Description
|
get_pak
|
None
|
PAK object
|
Returns PAK object
|
set_pak ($pak)
|
PAK object
|
None
|
Sets the PAK object
|
Cisco::CLM::Common::Policy
This module defines the policy object.
Method
|
Parameters
|
Return Value
|
Description
|
new
|
None
|
None
|
Creates Policy object
|
get_id
|
None
|
String
|
Returns the policy id
|
set_id($id)
|
String
|
None
|
Sets the policy id
|
get_request_id
|
None
|
String
|
Returns the request id
|
set_request_id
|
String
|
None
|
Sets the request ID
|
get_name
|
None
|
String
|
Returns the name of the policy
|
set_name($name)
|
String
|
None
|
Sets the name of the policy
|
get_owner
|
None
|
String
|
Returns the policy owner
|
set_owner($owner)
|
String
|
None
|
Sets the policy owner
|
get_description
|
None
|
String
|
Returns the policy description
|
set_description($desc)
|
String
|
None
|
Sets the policy description
|
is_public
|
None
|
Boolean
|
Returns true if policy is public, false otherwise
|
set_public($val)
|
Boolean
|
None
|
Sets the policy public
|
get_device_filter
|
None
|
DeviceFilter object
|
Returns the Device filter for the policy
|
set_device_filter($filter)
|
DeviceFilter object
|
None
|
Sets the Device filter for the policy
|
get_sku_filter
|
None
|
SKUFilter object
|
Returns the SKUFilter for the policy
|
set_sku_filter
|
SKUFilter object
|
None
|
Sets the SKUFilter for the policy
|
get_skus_in_use
|
None
|
SDUIdentifier object
|
Returns the SKU in use by the policy
|
set_skus_in_use($sku)
|
SKUIdentifier object
|
None
|
Sets the SKU in use by the policy
|
get_executed_by
|
None
|
String
|
Returns the user who executes the policy
|
set_executed_by($user)
|
String
|
None
|
Sets the user who executes the policy
|
get_executed_at
|
None
|
String
|
Returns the time of policy execution
|
set_executed_at($time)
|
Integer
|
None
|
Sets the time of policy execution, the time is the number of milliseconds since the epoch
|
Cisco::CLM::Common::PolicyStatus
This module defines the methods for asynchronous operation progress. It also supports the Status methods, apart from the ones defined below.
Method
|
Parameters
|
Return Value
|
Description
|
get_policy
|
None
|
Policy object
|
Returns the policy object
|
set_policy($policy)
|
Policy object
|
None
|
Sets the policy object
|
Cisco::CLM::Common::RehostableSKU
This module defines the methods for rehostable SKUs.
Method
|
Parameters
|
Return Value
|
Description
|
set_rehost_qty($qty)
|
Integer
|
None
|
Sets the number of rehostable skus
|
get_rehost_qty
|
None
|
Integer
|
Returns the number of rehostable skus
|
set_available_rehost_qty($qty)
|
Integer
|
None
|
Sets the number of skus available for rehost
|
get_available_rehost_qty
|
None
|
Integer
|
Returns the number of skus available for rehost
|
set_rehost_ticket($ticket)
|
String
|
None
|
Sets the rehost ticket
|
Cisco::CLM::Common::RehostableSKUStatus
This module defines the methods for rehostable SKU status.
Method
|
Parameters
|
Return Value
|
Description
|
get_rehostable_skus()
|
None
|
Array of Cisco::CLM::Common::RehostableSKU
|
Returns the array of RehostableSKUs
|
set_rehostable_skus([@skus])
|
Array of Cisco::CLM::Common::RehostableSKU
|
None
|
Sets the array of RehostableSKUs
|
Cisco::CLM::Common::RehostInfo
This module defines the methods for rehosting a license.
Method
|
Parameters
|
Return Value
|
Description
|
new
|
None
|
None
|
Creates RehostInfo object
|
get_permission_ticket
|
None
|
String
|
Returns the permission ticket obtained from Cisco.com
|
set_permission_ticket($ticket)
|
String
|
None
|
Sets the permission ticket for Rehost
|
get_rehost_ticket
|
None
|
String
|
Returns the rehost ticket obtained from the device
|
get_sku
|
None
|
Array of SKU object
|
Returns the SKU selected for rehost
|
set_sku ([@sku])
|
Array of SKU object
|
None
|
Sets the SKU for rehost
|
get_source_device_id
|
None
|
String
|
Returns the source device
|
set_source_device_id($src)
|
String
|
None
|
Sets the source device
|
get_dest_device_id
|
None
|
String
|
Returns the destination device
|
set_dest_device_id($dest)
|
String
|
None
|
Sets the destination device
|
Cisco::CLM::Common::RehostInfoStatus
This module defines the method for returning rehost status list. It inherits the methods defined in Cisco::CLM::Common::Status.
Method
|
Parameters
|
Return Value
|
Description
|
get_rehost_info_status_items
|
None
|
Array of RehostStatusItem
|
Returns the list of rehost information and their status
|
set_rehost_info_status_items(@list)
|
Array of RehostStatusItem
|
None
|
Sets the list of rehost information and their status
|
Cisco::CLM::Common::RehostInfoStatusItem
This module defines the method for returning the RehostInfo and its status. It inherits the methods defined in Cisco::CLM::Common::Status.
Method
|
Parameters
|
Return Value
|
Description
|
get_rehost_info
|
None
|
RehostInfo object
|
Returns the rehost information along with the status
|
set_rehost_info($info)
|
RehostInfo object
|
None
|
Sets the rehost information along with the status
|
Cisco::CLM::Common::RehostRequest
This module defines the methods requesting a license rehost.
Method
|
Parameters
|
Return Value
|
Description
|
get_sku_selection
|
None
|
Array of Cisco::CLM:: Common::RehostableSKU
|
Returns the SKU list for rehost
|
set_sku_selection(@list)
|
Array of Cisco::CLM:: Common::RehostableSKU
|
None
|
Sets the array of rehostable skus
|
get_source_device_id
|
None
|
String
|
Returns the source device ID
|
set_source_device_id($id)
|
String
|
None
|
Sets the source device ID
|
get_dest_device_id
|
None
|
String
|
Returns the destination device ID
|
set_dest_device_id($id)
|
String
|
None
|
Sets the destination device ID
|
Cisco::CLM::Common::ReportStatus
This module defines the methods for ReportStatus. It also inherits the methods of Cisco::CLM::Common::Status.
Method
|
Parameters
|
Return Value
|
Description
|
get_content
|
None
|
String
|
Returns the report content
|
set_content($content)
|
String
|
None
|
Sets the report content
|
get_format
|
None
|
One of the following Cisco::CLM::Common::
LicenseManagerInterface
::OutputFormat:
HTML, TEXT
|
Returns the report format
|
set_format($format)
|
One of the following Cisco::CLM::Common::
LicenseManagerInterface
::OutputFormat:
HTML, TEXT
|
None
|
Sets the report format
|
get_generated_at
|
None
|
String
|
Returns the generation date
|
set_generated_at($date)
|
Integer
|
None
|
Sets the report generation date, date is input as the number of milliseconds since the epoch
|
Cisco::CLM::Common::Schedule
This module defines the methods for scheduling a task(s).
Method
|
Parameters
|
Return Value
|
Description
|
new($clm_task)
|
One of the following
Cisco::CLM::Common::Schedule::ClmTask:
POLL_LICENSES
CHECK_EXPIRING_LICENSES
|
None
|
Creates the schedule object
|
get_frequency
|
None
|
One of the following
Cisco::CLM::Common::Schedule::Frequency:
EVERY_DAY, EVERY_TWO_DAYS, EVERY_THREE_DAYS, EVERY_FOUR_DAYS, EVERY_FIVE_DAYS, EVERY_SIX_DAYS, WEEKLY, EVERY_EIGHT_DAYS, EVERY_NINE_DAYS, EVERY_TEN_DAYS, EVERY_ELEVEN_DAYS, EVERY_TWELVE_DAYS, EVERY_THIRTEEN_DAYS, BI_WEEKLY
|
Returns the frequency of the task
|
set_frequency($frequency)
|
One of the following
Cisco::CLM::Common::Schedule::Frequency:
EVERY_DAY, EVERY_TWO_DAYS, EVERY_THREE_DAYS, EVERY_FOUR_DAYS, EVERY_FIVE_DAYS, EVERY_SIX_DAYS, WEEKLY, EVERY_EIGHT_DAYS, EVERY_NINE_DAYS, EVERY_TEN_DAYS, EVERY_ELEVEN_DAYS, EVERY_TWELVE_DAYS, EVERY_THIRTEEN_DAYS, BI_WEEKLY
|
None
|
Sets the frequency of the task
|
get_notify_if_less_than
|
None
|
Integer
|
Returns the number of days to notify if the license is expiring
|
set_notify_if_less_than($time)
|
Integer
|
None
|
Sets the number of days to notify if the license is expiring
|
get_schedule_name
|
None
|
String
|
Returns the schedule name
|
get_schedule_task
|
None
|
One of the following
Cisco::CLM::Common::Schedule::ClmTask:
POLL_LICENSES
CHECK_EXPIRING_LICENSES
|
Returns the ClmTask
|
set_starting_date($date)
|
integer
|
None
|
Sets the starting date, date is the time in milliseconds
|
get_starting_date
|
None
|
String
|
Returns the date as a string
|
get_discovery_auth_info
|
None
|
Array of Cisco::CLM::Common::DiscoveryAuthInfo
|
Returns the discovery authentication information
|
set_discovery_auth_info[@info]
|
Array of Cisco::CLM::Common::DiscoveryAuthInfo
|
None
|
Sets the discovery authentication information
|
get_user_name
|
None
|
String
|
Returns user name
|
set_user_name($name)
|
String
|
None
|
Sets user name
|
set_ip_masks([@mask])
|
Array of Cisco::CLM::Common::IpMask
|
None
|
Sets the IP mask
|
get_ip_masks
|
None
|
Array of Cisco::CLM::Common::IpMask
|
Returns the IP mask
|
Cisco::CLM::Common::SKU
This module defines the SKU.
Method
|
Parameters
|
Return Value
|
Description
|
new
|
None
|
None
|
Creates the SKU object
|
new($type,$name, $desc,
$ordered_qty, $avail_qty, @featuers, $entitlement, @lic_ids)
|
$type-String
$name-String
$desc-String
$ordered_qty-Integer
$avail_qty-Integer
@features-Array of String
$entitlement-String
@lic_ids-Array of String
|
|
|
get_type
|
None
|
Integer
|
Returns the SKU type, such as counted/uncounted
|
set_type($type)
|
Integer
|
None
|
Sets the type
|
get_name
|
None
|
String
|
ReturnsSKU name
|
set_name($name)
|
String
|
None
|
Sets SKU name
|
get_desc
|
None
|
String
|
Returns SKU description
|
set_desc($desc)
|
String
|
None
|
Sets SKU description
|
get_device_platforms
|
None
|
Array of Cisco::CLM:: Common::Device:: DevicePlatform
|
Returns the array of device platforms for the SKU
|
set_device_platforms([@platforms])
|
Array of Cisco::CLM:: Common::Device:: DevicePlatform
|
None
|
Sets the array of platforms for the SKU
|
get_ordered_qty
|
None
|
Integer
|
Returns the quantity of SKU ordered
|
set_ordered_qty($qty)
|
Integer
|
None
|
Sets the quantity ordered
|
get_available_qty
|
None
|
Integer
|
Returns the available qty
|
set_available_qty($qty)
|
Integer
|
None
|
Sets the available qty
|
get_features
|
None
|
Array of String
|
Returns the feature names for which the SKU was obtained
|
set_features(@feature)
|
Array of String
|
None
|
Sets the feature names for which the SKU was obtained
|
get_entitlement
|
None
|
String
|
Returns the PAK internal id
|
set_entitlement($entitlement)
|
String
|
None
|
Sets the entitlement
|
get_license_ids
|
None
|
Array of String
|
Returns the license IDs
|
set_ license_ids (@list)
|
Array of String
|
None
|
Sets the license IDs
|
get_count
|
None
|
String
|
Returns the count available in the ordered SKU
|
set_count($count)
|
String
|
None
|
Sets the count
|
Cisco::CLM::Common::SKUFilter
This module defines the SKUFilter for the policy.
Method
|
Parameters
|
Return Value
|
Description
|
new
|
None
|
None
|
Creates the SKUFilter object
|
get_feature_name
|
None
|
String
|
Returns the interested feature name
|
set_feature_name($name)
|
String
|
None
|
Sets the interested feature name
|
Cisco::CLM::Common::SKUIdentifier
This module identifies the selected SKU for the policy with the PAK to which it belongs.
Method
|
Parameters
|
Return Value
|
Description
|
get_pak
|
None
|
PAK object
|
Returns the PAK of the selected SKU
|
set_pak($pak)
|
PAK
|
None
|
Sets the PAK of the selected SKU
|
get_sku
|
None
|
SKU object
|
Returns the SKU object
|
set_sku($sku)
|
SKU object
|
None
|
Sets the SKU object
|
Cisco::CLM::Common::Status
This module defines the error code and the messages for a request.
Method
|
Parameters
|
Return Value
|
Description
|
get_error_code
|
None
|
Integer
|
Returns the error code
|
set_error_code($code)
|
Integer
|
None
|
Sets the error code
|
get_error_message
|
None
|
String
|
Returns the error message
|
set_error_message($msg)
|
String
|
None
|
Sets the error message
|
get_cause
|
None
|
String
|
Returns the cause
|
get_fault
|
None
|
String
|
Returns the fault
|
get_item_count
|
None
|
int
|
Returns the item count
|
get_status_item
|
int
|
Status
|
Returns the status object
|
get_suggestion
|
None
|
String
|
Returns the suggestion
|
Cisco::CLM::Common::UsageInfo
This module defines the usage information for a license line.
Method
|
Parameters
|
Return Value
|
Description
|
get_total_usage
|
None
|
Integer
|
Returns the total usage in milliseconds read from the device
|
set_total_usage($usage)
|
Integer
|
None
|
Sets the total usage
|
get_usage_left
|
None
|
Integer
|
Returns the usage left in milliseconds read from the device
|
set_usage_left($left)
|
Integer
|
None
|
Sets the usage left
|
Cisco::CLM::Common::UserInfo
This module defines the details and the roles for a user.
Method
|
Parameters
|
Return Value
|
Description
|
Method
|
Parameters
|
Return Value
|
Description
|
new($username)
|
String
|
None
|
Creates the UserInfo object with given username
|
new($username,$password,$role)
|
$username-String
$password-String
$role- One of the following
Cisco::CLM::Common::UserInfo::Role:
ADMIN
INVENTORYMGR
PAKMGR
LICENSEMGR
REPORTMGR
|
None
|
Creates the UserInfo object with given usename, password, role
|
get_days_before_show_exp_lic
|
None
|
integer
|
Returns the number of days
|
set_days_before_show_exp_lic($days)
|
integer
|
None
|
Sets the number of days
|
get_eula_accepted_time
|
None
|
String
|
Returns the eula accepted time
|
set_eula_accepted_time($time)
|
Integer
|
None
|
Sets the eula accepted time, date is entered as number of milliseconds since the epoch
|
get_show_exp_lic
|
None
|
Boolean
|
Returns Boolean true/false
|
set_show_exp_lic
|
Boolean
|
None
|
Sets Boolean true/false
|
get_username
|
None
|
String
|
Returns username
|
get_password
|
None
|
String
|
Returns password
|
set_password($pwd)
|
String
|
None
|
Sets password
|
get_first_name
|
None
|
String
|
Returns user's first name
|
set_first_name($name)
|
String
|
None
|
Sets user's first name
|
get_last_name
|
None
|
String
|
Returns user's last name
|
set_last_name($name)
|
String
|
None
|
Sets user's last name
|
get_company_name
|
None
|
String
|
Returns company name
|
set_company_name($name)
|
String
|
None
|
Sets company name
|
get_email_addresss
|
None
|
String
|
Returns email address
|
set_email_address($email)
|
String
|
None
|
Sets email address
|
is_email_notification_enabled
|
None
|
Boolean
|
Returns true if email enabled, false otherwise
|
set_email_enabled($val)
|
Boolean
|
None
|
Sets email_enabled
|
get_cco_username
|
None
|
String
|
Returns the CCO username
|
set_cco_username($name)
|
String
|
None
|
Sets the CCO username
|
get_cco_password
|
None
|
String
|
Returns the CCO password
|
set_cco_password($pwd)
|
String
|
None
|
Sets the CCO password
|
get_role
|
None
|
One of the following
Cisco::CLM::Common::UserInfo::Role:
ADMIN,INVENTORYMGR
PAKMGR
LICENSEMGR
REPORTMGR
|
Returns the user role
|
set_role($role)
|
One of the following
Cisco::CLM::Common::UserInfo::Role:
ADMIN,INVENTORYMGR
PAKMGR
LICENSEMGR
REPORTMGR
|
None
|
Sets the user role
|
get_has_agree_eula
|
None
|
Boolean
|
Returns true, if user has agreed to eula, false otherwise
|
set_has_agree_eula($val)
|
Boolean
|
None
|
Sets has_agree_eula
|
get_do_not_ask_eula_again
|
None
|
Boolean
|
Returns true, if user says do_not_ask_eula_again, false otherwise
|
set_do_not_ask_eula_again($val)
|
Boolean
|
None
|
Sets do_not_ask_eula_again
|
Cisco::CLM::Common::UserPwd
This module defines the methods for setting and accessing usernames and their passwords.
Method
|
Parameters
|
Return Value
|
Description
|
new($username,$password)
|
$username-String
$password-String
|
None
|
Creates UserPwd object
|
get_username
|
None
|
String
|
Returns username list
|
set_username($name)
|
String
|
None
|
Sets username list
|
get_password
|
None
|
String
|
Returns password list
|
set_password($pwd)
|
String
|
None
|
Sets password list
|
Cisco::CLM::Common::UserToken
This module defines the UserToken used by Cisco License Manager.
Method
|
Parameters
|
Return Value
|
Description
|
get_idle_timeout
|
None
|
Integer
|
Returns the idle timeout for the given usertoken, 0 represents permanent
|
set_idle_timeout
|
Integer
|
None
|
Sets the timeout
|
is_ssl_enabled
|
None
|
Boolean
|
Returns true if SSL enabled, false otherwise
|
set_ssl_enabled($val)
|
Boolean
|
None
|
Sets if SSL enabled
|
get_username
|
None
|
String
|
Returns username in the server account
|
set_username($name)
|
String
|
None
|
Sets username
|
get_token
|
None
|
String
|
Returns token generated by server during login
|
Cisco::CLM::Common::XRSlotInfo
This module stores the license information for the slots on Cisco12K routers.
Method
|
Parameters
|
Return Value
|
Description
|
new
|
String
|
None
|
Creates the XRSlotInfo object
|
get_active_license_count
|
None
|
integer
|
Returns the license count active on the slot
|
get_allocated_count
|
None
|
integer
|
Returns the license count allocated on the slolt
|
get_pool_name
|
None
|
String
|
Returns the license pool name
|
get_slot_name
|
None
|
String
|
Returns the slot name
|
get_slot_udi
|
None
|
String
|
Returns the slot udi
|
set_active_license_count($count)
|
integer
|
None
|
Sets the active license count
|
set_allocated_count($count)
|
integer
|
None
|
Sets the allocated license count
|
set_pool_name($name)
|
String
|
None
|
Sets the pool name
|
set_slot_name($name)
|
String
|
None
|
Sets the slot name
|
set_slot_udi($name)
|
String
|
None
|
Sets the slot udi
|
