Perl Data Object Documentation for root_objects, version 1. 0.
Objects
Configuration
Description: Root object for configuration
Child objects:
AAA - Authentication, Authorization and Accounting
APS - SONET Automatic Protection Switching (APS) configuration
ARP - ARP configuration
ATM - Global ATM configuration
ActiveNodeTable - Per-node configuration for active nodes
BFD - BFD Configuration
BGP - BGP configuration commands
CDP - Global CDP configuration data
ControlPlane - Configure control Plane
Crypto - Crypto configuration
DHCPV6D - IPV6 DHCP config data
DynamicConfigurationTemplates - All dynamic template configurations
EIGRP - Configure Neighbor
ES_ACL - Layer 2 ACL configuration data
EtherLinkOAMGlobalConfig - Ethernet Link OAM Global Configuration
EthernetFeatures - Ethernet Features Configuration
GlobalAFI_SAFITable - Default VRF configuration
GlobalInterfaceConfiguration - The configuration for all interfaces
HSRPCfg - HSRP configuration
ICMP - IP ICMP configuration data
IGMP - IGMPconfiguration
IP - IP TCP Configuration Data
IPAddressPool - IP address pool configuration data
IPExplicitPaths - IP Explicit Path config data
IPSLA - IPSLA configuration
IPV4DHCPD - Dhcp Ipv4 configuration
IPV4NetworkGlobal - IPv4 network global configuration data
IPV4_ACLAndPrefixList - IPv4 ACL configuration data
IPV6_ACLAndPrefixList - IPv6 ACL configuration data
IP_ARM - IP Address Repository Manager (IPv4/IPv6 ARM) configuration data
IP_TCP - Global IP TCP configuration
ISIS - IS-IS configuration for all instances
InterfaceConfigurationTable - The configuration for all interfaces
Ipv4Pool - Configure IPv4 Pool
KeychainTable - Configure a Key Chain
L2VPN - L2VPN configuration
LACP - Link Aggregation Control Protocol commands
LR - The pairing configuration is held in here.
MFWD - Multicast routing configuration
MPLSInfra - The root of MPLS infrastructure configuration
MPLS_LDP - MPLS LDP configuration
MPLS_LSD - MPLS LSD configuration data
MPLS_OAM - MPLS LSP verification configuration
MPLS_TE - The root of MPLS TE configuration
MSDP - MSDP Configuration
NTP - NTP configuration
NetFlow - NetFlow Configuration
OSPF - OSPF configuration data
OUNI - OUNI Configuration
PIM - PIM configuration
Parser - Parser configuration
PerfMgmt - Performance Management configuration & operations
Placement - Process placement configuration
PolicyManager - Global Policy Manager configuration.
PreconfiguredNodeTable - Per-node configuration for non-active nodes
QOS - Global QOS configuration.
RIP - RIP configuration
RSVP - Global RSVP configuration commands
RouterStatic - This class represent router static submode configuration
RoutingPolicy - Routing policy configuration
SAP - SAP Listener
SBCService - Session Border Controller Configuration
SNMP - The heirarchy point for all the SNMP configurations
ServiceRoleConfigurationTable - Service Role configuration.
Syslog - Modify message logging facilities
SyslogService - Syslog Timestamp Services
TTY - TTY Line Configuration
Tunnel - Tunnel template used for L3 VPNs
UDP_SNMP - UDP SNMP heirarchy point
VRFTable - VRF configuration
VRRPCfg - VRRP configuration
VTY - VTY Pools configuration
Applicable methods: find_data
Operational
Description: Root object for operational data
Child objects:
AAA - AAA operational data
APS - SONET Automatic Protection Switching (APS) info
ATM_ILMI - ATM ILMI operational data
ATM_OAM - ATM OAM operational data
ATM_VCClass - ATM VC class data
ATM_VCM - ATM VCM operational data
AlarmLogger - Alarm Logger operational data
AlphaDisplay - Alpha Display Operational data space
AutoRP - AutoRP operational data
BFD - Bidirectional Forwarding Detection(BFD) operational data
BGP - BGP operational data
Bundles - Bundle operational data
CDP - CDP operational data
CHDLC_MA - Per interface operational data for the cHDLC MA
Correlator - Correlator operational data
CryptoCertificateAuthority - Public Key Infrastructure Related Information
CryptoEngine - Crypto Engine
DHCPV6D - IPV6 DHCP operational data
DPT - DPT operational data
DWDM - DWDM operational data
EIGRP - EIGRP operational data
ES_ACL - Root class of ES ACL Oper schema tree
EnvironmentalMonitoring - Environmental Monitoring Operational data space
EtherLinkOAM - Ethernet Link OAM operational data
HSRPOper - HSRP operational data
IKE - IKE operational data
IPAddressPoolProxy - IP address pool proxy operational data
IPAddressPoolServer - IP address pool operational data
IPSLA - IPSLA operational data
IPSecDynamicSessionInfo - IPSec operational data
IPSecStaticSessionInfo - IPSec operational data
IPV4ARM - IPv4 Address Repository Manager (IPv4 ARM) operational data
IPV4DHCPD - IPv4 DHCPD operational data
IPV4Network - IPv4 network operational data
IPV4_ACLAndPrefixList - Root class of IPv4 Oper schema tree
IPV6ARM - IPv6 Address Repository Manager (IPv6 ARM) operational data
IPV6Network - IPv6 network operational data
IPV6_ACLAndPrefixList - Root class of IPv6 Oper schema tree
ISIS - IS-IS operational data
InfraPacketManager - Packet manager infrastructure
InfraStatistics - Statistics Infrastructure
InterfaceAttributes - Hardware and software attributes for interfaces
InterfaceProperties - Non feature-specific interface operational data
Inventory - Logical Router Inventory operational data
Ipv4Pool - IPv4 Pool operational data
L2VPN - L2VPN operational data
L2VPNForwarding - Show L2VPN forwarding
L3VPN - L3VPN operational data
LACPBundleMembers - LACP Bundle Member operational data
LACPBundles - LACP bundle data
LACPData - LACP data
LR - Information about the current LR scoped state of LR inventory.
MFWD - MFWD operational data
MPLS_LDP - MPLS LDP operational data
MPLS_PCE - MPLS PCE operational data
MRIB - MRIB operational data
MSDP - MSDP operational data
MgmtMultilink - MgmtMultilink controller operational data
Multilink - Multilink interface operational data
NTP - NTP operational data
NetFlow - NetFlow operational data
OSPF - OSPF operational data
PIM - PIM operational data
PM - PM operational data
PPP - PPP operational data
PerfMgmt - Performance Management agent operational data
PerformanceManagement - DWDM performace data
Placement - Process placement operational state
PlatformInventory - Inventory operational data
PolicyManager - Policy-map operational data
QOS - QOS operational data
RIP - RIP operational data
RoutingPolicy - Routing policy operational data
SAP - SAP operational data
SNMP - SNMP operational data
SONET - SONET operational data
SONET_SDH - SONET-SDH operational data
SRP - SRP operational data
Sbc - SBC operational Data
ServiceDiversion - Service Diversion operational data
ServiceRedundancy - Service Redundancy operational data
ServiceRole - Service Role Daemon operational data
Suppression - Suppression operational data
T1E1 - T1E1 operational data
T3E3 - T3E3 operational data
TCPConnection - TCP connection operational data
TCP_NSR - TCP NSR operational data
TTY - TTY Line Configuration
VLAN - VLAN operational data
VRRPOper - VRRP operational data
WANPHY - WANPHY operational data
Action
Description: Root object for action data
Child objects:
AlarmLogger - Alarm Logger action data
BGP - Container class for BGP action data
CDP - CDP action data
ClearL2VPNForwardingStatistics - Clear L2VPN forwarding statistics
Correlator - Correlator action data
CryptoIKE - Container class for crypto IKE action data
CryptoIpsec - Container class for crypto IPSec action data
DHCPV6D - IPV6 DHCP action data
DPT - DPT action data
DWDM - DWDM action data
EIGRP - EIGRP action data
ES_ACL - ES ACL actions
EtherLinkOAM - Ethernet Link OAM action commands
IGMP - IGMP action data
IPV4DHCPD - IPV4 DHCPD Proxy actions
IPV4_ACLAndPrefixList - IPv4 ACL actions
IPV4_DHCPD - IPV4 DHCPD Snoop actions
IPV6_ACLAndPrefixList - IPv6 ACL and PrefixList actions
ISIS - IS-IS action data
InfraStatistics - Statistics Infrastructure
L2VPN - L2VPN actions
L2VPNForwarding - L2VPN forwarding actions
LACPBundleMembers - LACP action commands
MFWD - Multicast Forwarding action data
MFWDPlatform - Hardware Multicast Forwarding action commands
MPLS_LCAC - MPLS-LCAC action data
MPLS_LDP - MPLS LDP action data
MPLS_LSD - MPLS LSD action data
MPLS_TE - MPLS Traffic Engineering action data
MSDP - MSDP action data
MgmtMultilink - Multilink controller action data
NTP - NTP action data
NetFlow - NetFlow action data
OSPF - OSPF action data
PCE - PCE action data
PIM - PIM action data
Placement - Process placement action data
QOS - QOS action data
RIP - RIP action data
RSVP - RSVP actions
SNMP - SNMP action data
SONET - SONET action data
SRP - SRP actions
ServiceRedundancy - Service Redundancy Actions
T1E1 - T1E1 action data
T3E3 - T3E3 action data
TCP - TCP action data
TCP_NSR - NSR action data
WANPHY - WANPHY action data
AdminOperational
Description: Root object for admin-plane operational data
Task IDs required: admin
Child objects:
AlphaDisplay - Alpha Display Operational data space
EnvironmentalMonitoring - Environmental Monitoring Operational data space
Install - Information of software packages and install operations
Inventory - Inventory operational data
License - Information of license list and operations
NTP - NTP admin operational data
PlatformInventory - Inventory operational data
AdminAction
Description: Root object for admin-plane action data
Task IDs required: admin
Child objects:
License - Information of license operations
Perl Data Object Documentation for mpls_lcac_action, version 1. 4.
Objects
MPLS_LCAC
Description: MPLS-LCAC action data
Task IDs required: mpls-te
Parent objects:
Action
Child objects:
Clear - MPLS-LCAC counters clearing action.
FloodAllLocalLinks - Causes an immediate flooding of all the local links.
Applicable methods: set_data
Clear
Description: MPLS-LCAC counters clearing action.
Parent objects:
MPLS_LCAC
Child objects:
Statistics - Clears all the statistics in MPLS-LCAC.
Applicable methods: set_data
Statistics
Description: Clears all the statistics in MPLS-LCAC.
Parent objects:
Clear
Values:
Exec (mandatory)
Type: xsd:boolean
Description: True only
Default value: none.
Applicable methods: set_data
FloodAllLocalLinks
Description: Causes an immediate flooding of all the local links.
Parent objects:
MPLS_LCAC
Values:
Exec (mandatory)
Type: xsd:boolean
Description: True only
Default value: none.
Applicable methods: set_data
Perl Data Object Documentation for ip_static_cfg, version 2. 0.
Objects
RouterStatic
Description: This class represent router static submode configuration
Task IDs required: static
Parent objects:
Configuration
Child objects:
DefaultVRF - Default VRF configuration
MaximumRoutes - The maximum number of static routes that can be configured.
VRFTable - VRF static configuration container
Applicable methods: find_data, set_data, delete_data
MaximumRoutes
Description: The maximum number of static routes that can be configured.
Parent objects:
RouterStatic
Child objects:
MaxIPV4Value - The maximum number of static routes that can be configured for IPv4 AFI.
MaxIPV6Value - The maximum number of static routes that can be configured for IPv6 AFI.
Applicable methods: find_data, set_data, delete_data
MaxIPV4Value
Description: The maximum number of static routes that can be configured for IPv4 AFI.
Parent objects:
MaximumRoutes
Values:
MaximumRoutes (mandatory)
Type: Range. Value lies between 1 and 140000
Description: The maximum number of static routes that can be configured for this AFI
Default value:
MaximumRoutes => 4000
Applicable methods: get_data, set_data, delete_data
MaxIPV6Value
Description: The maximum number of static routes that can be configured for IPv6 AFI.
Parent objects:
MaximumRoutes
Values:
MaximumRoutes (mandatory)
Type: Range. Value lies between 1 and 140000
Description: The maximum number of static routes that can be configured for this AFI
Default value:
MaximumRoutes => 4000
Applicable methods: get_data, set_data, delete_data
DefaultVRF
Description: Default VRF configuration
Parent objects:
RouterStatic
Child objects:
AddressFamily - Address family configuration
Applicable methods: find_data, set_data, delete_data
AddressFamily
Description: Address family configuration
Parent objects:
DefaultVRF
VRF
Child objects:
VRFIPV4 - IPv4 static configuration
VRFIPV6 - IPv6 static configuration
Applicable methods: find_data, set_data, delete_data
VRFIPV4
Description: IPv4 static configuration
Parent objects:
AddressFamily
Child objects:
VRFMulticast - Multicast static configuration
VRFUnicast - Unicast static configuration
Applicable methods: find_data, set_data, delete_data
VRFUnicast
Description: Unicast static configuration
Parent objects:
VRFIPV4
VRFIPV6
Child objects:
DefaultTopology - Default topology configuration
TopologyTable - Topology static configuration container
VRFPrefixTable - The set of all Static Topologies for this AFI.
Applicable methods: find_data, set_data, delete_data
VRFPrefixTable
Description: The set of all Static Topologies for this AFI.
Parent objects:
VRFUnicast
VRFMulticast
Child objects:
VRFPrefix - A static route
Applicable methods: get_keys, set_data, delete_data
VRFPrefix
Description: A static route
Parent objects:
VRFPrefixTable
Keys:
Prefix
Type: IPAddress
Description: Destination prefix
Length
Type: Range. Value lies between 0 and 128
Description: Destination prefix length
Child objects:
VRFRecurseRouteTable - A recursive next VRF static route
VRFRouteTable - A connected or recursive static route
Applicable methods: find_data, set_data, delete_data
VRFRecurseRouteTable
Description: A recursive next VRF static route
Parent objects:
VRFPrefix
VRFPrefixTopology
Child objects:
VRFRecurseRoute - A recursive next vrf static route
Applicable methods: get_keys, set_data, delete_data
VRFRecurseRoute
Description: A recursive next vrf static route
Parent objects:
VRFRecurseRouteTable
Keys:
VRFName (mandatory)
Type: xsd:string
Description: Fallback or recusive vrf name
Child objects:
VRFRecursiveNexthopInfoTable - The set of nexthop information configured for this route
Applicable methods: find_data, set_data, delete_data
VRFRecursiveNexthopInfoTable
Description: The set of nexthop information configured for this route
Parent objects:
VRFRecurseRoute
Child objects:
VRFNexthopInfo - A forwarding interface and/or the address of a nexthop router for this route (one of these must be specified)
Applicable methods: get_keys, get_entries, set_data, delete_data
VRFNexthopInfo
Description: A forwarding interface and/or the address of a nexthop router for this route (one of these must be specified)
Parent objects:
VRFNexthopInfoTable
VRFRecursiveNexthopInfoTable
Keys:
Interface
Type: Interface
Description: Forwarding interface
Address
Type: IPAddress
Description: Nexthop address
Values:
BFDFastDetect
Type: xsd:boolean
Description: If set, bfd is enabled
MinimumInterval
Type: Range. Value lies between 10 and 10000
Description: BFD Hello interval in milliseconds
DetectMultiplier
Type: Range. Value lies between 1 and 10
Description: BFD Detect Multiplier
Metric
Type: Range. Value lies between 1 and 254
Description: Distance metric for this path
Tag
Type: Range. Value lies between 1 and -1
Description: Tag for this path
PermanentFlag
Type: xsd:boolean
Description: If set, path is permanent
VRFLablel
Type: Range. Value lies between 0 and -1
Description: VRF LABEL
TunneID
Type: Range. Value lies between 0 and 65535
Description: Tunnel ID for this path
Description
Type: xsd:string
Description: Short Description of Static Route
Default value:
BFDFastDetect => false
MinimumInterval => 100
DetectMultiplier => 3
Metric => 1
Tag => null
PermanentFlag => false
VRFLablel => 0
TunneID => 0
Description =>
Applicable methods: get_data, set_data, delete_data
VRFRouteTable
Description: A connected or recursive static route
Parent objects:
VRFPrefix
VRFPrefixTopology
Child objects:
VRFNexthopInfoTable - The set of nexthop information configured for this route
Applicable methods: find_data, set_data, delete_data
VRFNexthopInfoTable
Description: The set of nexthop information configured for this route
Parent objects:
VRFRouteTable
Child objects:
VRFNexthopInfo - A forwarding interface and/or the address of a nexthop router for this route (one of these must be specified)
Applicable methods: get_keys, get_entries, set_data, delete_data
DefaultTopology
Description: Default topology configuration
Parent objects:
VRFUnicast
VRFMulticast
Child objects:
VRFPrefixTopologyTable - The set of all Static Topologies for this AFI.
Applicable methods: find_data, set_data, delete_data
VRFPrefixTopologyTable
Description: The set of all Static Topologies for this AFI.
Parent objects:
DefaultTopology
Topology
Child objects:
VRFPrefixTopology - A static route
Applicable methods: get_keys, set_data, delete_data
VRFPrefixTopology
Description: A static route
Parent objects:
VRFPrefixTopologyTable
Keys:
Prefix
Type: IPAddress
Description: Destination prefix
Length
Type: Range. Value lies between 0 and 128
Description: Destination prefix length
Child objects:
VRFRecurseRouteTable - A recursive next VRF static route
VRFRouteTable - A connected or recursive static route
Applicable methods: find_data, set_data, delete_data
TopologyTable
Description: Topology static configuration container
Parent objects:
VRFUnicast
VRFMulticast
Child objects:
Topology - Topology static configuration
Applicable methods: get_keys, set_data, delete_data
Topology
Description: Topology static configuration
Parent objects:
TopologyTable
Keys:
TopologyName (mandatory)
Type: xsd:string
Description: Topology name
Child objects:
VRFPrefixTopologyTable - The set of all Static Topologies for this AFI.
Applicable methods: find_data, set_data, delete_data
VRFMulticast
Description: Multicast static configuration
Parent objects:
VRFIPV4
VRFIPV6
Child objects:
DefaultTopology - Default topology configuration
TopologyTable - Topology static configuration container
VRFPrefixTable - The set of all Static Topologies for this AFI.
Applicable methods: find_data, set_data, delete_data
VRFIPV6
Description: IPv6 static configuration
Parent objects:
AddressFamily
Child objects:
VRFMulticast - Multicast static configuration
VRFUnicast - Unicast static configuration
Applicable methods: find_data, set_data, delete_data
VRFTable
Description: VRF static configuration container
Parent objects:
RouterStatic
Child objects:
VRF - VRF static configuration
Applicable methods: get_keys, set_data, delete_data
VRF
Description: VRF static configuration
Parent objects:
VRFTable
Keys:
VRFName (mandatory)
Type: xsd:string
Description: VRF name
Child objects:
AddressFamily - Address family configuration
Applicable methods: find_data, set_data, delete_data
Datatypes
StaticRoutingSubAddressFamilyType
Definition: Enumeration. Valid values are:
'Unicast' - Unicast
'Multicast' - Multicast
Perl Data Object Documentation for crypto_ipsec_action, version 1. 1.
Objects
CryptoIpsec
Description: Container class for crypto IPSec action data
Task IDs required: crypto
Parent objects:
Action
Child objects:
Clear - Container class for clear actions
Applicable methods: set_data
Clear
Description: Container class for clear actions
Parent objects:
CryptoIpsec
Child objects:
AllSecurityAssociations - Clear all IPSec SAs
AllSecurityAssociationsCouters - Clear all IPSEC SA Counters
AllStatistics - Clear all IPSec VRF statistics
Counters - IPSec SA Counters
SecurityAssociationTable - IPSec SA Table
SecurityAssociationsForInterfaceTable - IPSec Interface Table
Statistics - IPSec VRF statistics
Applicable methods: set_data
SecurityAssociationTable
Description: IPSec SA Table
Parent objects:
Clear
Child objects:
SecurityAssociation - SA Entry
Applicable methods: set_data
SecurityAssociation
Description: SA Entry
Parent objects:
SecurityAssociationTable
Keys:
ID (mandatory)
Type: xsd:unsignedInt
Description: SA ID
Values:
True (mandatory)
Type: xsd:boolean
Description: Clear SA
Default value: none.
Applicable methods: set_data
AllSecurityAssociations
Description: Clear all IPSec SAs
Parent objects:
Clear
Values:
True (mandatory)
Type: xsd:boolean
Description: Clear all SAs
Default value: none.
Applicable methods: set_data
SecurityAssociationsForInterfaceTable
Description: IPSec Interface Table
Parent objects:
Clear
Child objects:
Interface - Interface Entry
Applicable methods: set_data
Interface
Description: Interface Entry
Parent objects:
SecurityAssociationsForInterfaceTable
Keys:
Interface (mandatory)
Type: Interface
Description: IPSec interface name
Values:
True (mandatory)
Type: xsd:boolean
Description: Clear SAa for Interface
Default value: none.
Applicable methods: set_data
Counters
Description: IPSec SA Counters
Parent objects:
Clear
Child objects:
SecurityAssociation - SA Entry
Applicable methods: set_data
SecurityAssociation
Description: SA Entry
Parent objects:
Counters
Keys:
ID (mandatory)
Type: xsd:unsignedInt
Description: SA ID
Values:
True (mandatory)
Type: xsd:boolean
Description: Clear SA countes
Default value: none.
Applicable methods: set_data
AllSecurityAssociationsCouters
Description: Clear all IPSEC SA Counters
Parent objects:
Clear
Values:
True (mandatory)
Type: xsd:boolean
Description: Clear all SAs
Default value: none.
Applicable methods: set_data
Statistics
Description: IPSec VRF statistics
Parent objects:
Clear
Child objects:
VRF - IVRF name
Applicable methods: set_data
VRF
Description: IVRF name
Parent objects:
Statistics
Keys:
VRF (mandatory)
Type: BoundedString. Length less than or equal to 32
Description: IVRF name
Values:
True (mandatory)
Type: xsd:boolean
Description: Clear SA countes
Default value: none.
Applicable methods: set_data
AllStatistics
Description: Clear all IPSec VRF statistics
Parent objects:
Clear
Values:
True (mandatory)
Type: xsd:boolean
Description: Clear all SAs
Default value: none.
Applicable methods: set_data
Perl Data Object Documentation for manageability_perf_cfg_common, version 4. 0.
Objects
PerfMgmt
Description: Performance Management configuration & operations
Task IDs required: monitor
Parent objects:
Configuration
Child objects:
Enable - Start data collection and/or threshold monitoring
Resources - Resources configuration
Statistics - Templates for collection of statistics
Threshold - Container for threshold templates
Applicable methods: find_data, set_data, delete_data
Resources
Description: Resources configuration
Parent objects:
PerfMgmt
Child objects:
MemoryResources - Configure the memory usage limits of performance management
TFTPResources - Configure the TFTP server IP address and directory name
Applicable methods: find_data, set_data, delete_data
TFTPResources
Description: Configure the TFTP server IP address and directory name
Parent objects:
Resources
Values:
ServerAddress
Type: IPV4Address
Description: IP address of the TFTP server
Directory
Type: xsd:string
Description: Directory name on TFTP server
Default value: none.
Applicable methods: get_data, set_data, delete_data
MemoryResources
Description: Configure the memory usage limits of performance management
Parent objects:
Resources
Values:
MaxLimit
Type: xsd:unsignedInt
Description: Maximum limit for memory usage (Kbytes) for data buffers
MinReserved
Type: xsd:unsignedInt
Description: Specify a minimum free memory (Kbytes) to be ensured before allowing a collection request
Default value: none.
Applicable methods: get_data, set_data, delete_data
Enable
Description: Start data collection and/or threshold monitoring
Parent objects:
PerfMgmt
Child objects:
MonitorEnable - Start data collection for a monitored instance
Statistics - Start periodic collection using a defined a template
Threshold - Start threshold monitoring using a defined template
Applicable methods: find_data, set_data, delete_data
Datatypes
PIDRange
Definition: Range. Value lies between 0 and -1
Perl Data Object Documentation for licmgr_adminoper, version 1. 3.
Objects
License
Description: Information of license list and operations
Task IDs required: sysmgr
Parent objects:
AdminOperational
Child objects:
BackupTable - License backup file information
Log - License operation log
PoolTable - License Pools configuration information
RehostTickets - Rehost Tickets information
Status - Status information of license
UDIInformationTable - Unique Device Identifier information
Applicable methods: find_data
Status
Description: Status information of license
Parent objects:
License
Child objects:
Active - Active license information
Allocated - Allocated license information
Available - Available license information
Evaluation - Evaluation license information
Expired - Expired license information
FeatureTable - Feature ID information of license
LocationTable - Location information of license
SDRTable - Secure Domain Router information of license
Applicable methods: find_data
Active
Description: Active license information
Parent objects:
Status
Child objects:
FeatureTable - Feature ID information of license
LocationTable - Location information of license
SDRTable - Secure Domain Router information of license
Applicable methods: find_data
FeatureTable
Description: Feature ID information of license
Parent objects:
Status
Active
Allocated
Available
Evaluation
Expired
Child objects:
Feature - License information for specific feature
Applicable methods: get_keys, get_entries
Feature
Description: License information for specific feature
Parent objects:
FeatureTable
Keys:
Feature (mandatory)
Type: BoundedString. Length less than or equal to 31
Description: Feature ID
Value: license_request_feature
Applicable methods: get_data
LocationTable
Description: Location information of license
Parent objects:
Status
Active
Allocated
Available
Evaluation
Expired
Child objects:
Location - License information for specific node
Applicable methods: get_keys, get_entries
Location
Description: License information for specific node
Parent objects:
LocationTable
Keys:
Node (mandatory)
Type: NodeID
Description: Node
Value: license_request_location
Applicable methods: get_data
SDRTable
Description: Secure Domain Router information of license
Parent objects:
Status
Active
Allocated
Available
Evaluation
Expired
Child objects:
SDR - License information for specific Secure Domain Router
Applicable methods: get_keys, get_entries
SDR
Description: License information for specific Secure Domain Router
Parent objects:
SDRTable
Keys:
SDRName (mandatory)
Type: BoundedString. Length less than or equal to 32
Description: SDR Name
Value: license_request_sdr
Applicable methods: get_data
Allocated
Description: Allocated license information
Parent objects:
Status
Child objects:
FeatureTable - Feature ID information of license
LocationTable - Location information of license
SDRTable - Secure Domain Router information of license
Applicable methods: find_data
Available
Description: Available license information
Parent objects:
Status
Child objects:
FeatureTable - Feature ID information of license
LocationTable - Location information of license
SDRTable - Secure Domain Router information of license
Applicable methods: find_data
Evaluation
Description: Evaluation license information
Parent objects:
Status
Child objects:
FeatureTable - Feature ID information of license
LocationTable - Location information of license
SDRTable - Secure Domain Router information of license
Applicable methods: find_data
Expired
Description: Expired license information
Parent objects:
Status
Child objects:
FeatureTable - Feature ID information of license
LocationTable - Location information of license
SDRTable - Secure Domain Router information of license
Applicable methods: find_data
Log
Description: License operation log
Parent objects:
License
Child objects:
Administration - Administration log information
Operational - License operational log information
Applicable methods: find_data
Operational
Description: License operational log information
Parent objects:
Log
Child objects:
FeatureIDTable - Feature ID information of license operation log
LocationNumberTable - Location information of license operation log
RequestIDTable - ID information of license operation log
SDRNameTable - Secure Domain Router information of license operation log
Applicable methods: find_data
RequestIDTable
Description: ID information of license operation log
Parent objects:
Operational
Administration
Child objects:
RequestID - License log information for specific ID
Applicable methods: get_keys, get_entries
RequestID
Description: License log information for specific ID
Parent objects:
RequestIDTable
Keys:
ID (mandatory)
Type: Range. Value lies between 1 and 9999
Description: Request ID
Value: license_log_req
Applicable methods: get_data
FeatureIDTable
Description: Feature ID information of license operation log
Parent objects:
Operational
Administration
Child objects:
FeatureID - License log information for specific feature
Applicable methods: get_keys, get_entries
FeatureID
Description: License log information for specific feature
Parent objects:
FeatureIDTable
Keys:
Feature (mandatory)
Type: BoundedString. Length less than or equal to 31
Description: Feature ID
Value: license_log_feature
Applicable methods: get_data
LocationNumberTable
Description: Location information of license operation log
Parent objects:
Operational
Administration
Child objects:
LocationNumber - License log information for specific node
Applicable methods: get_keys, get_entries
LocationNumber
Description: License log information for specific node
Parent objects:
LocationNumberTable
Keys:
Node (mandatory)
Type: NodeID
Description: Node
Value: license_log_location
Applicable methods: get_data
SDRNameTable
Description: Secure Domain Router information of license operation log
Parent objects:
Operational
Administration
Child objects:
SDRName - License log information for specific SecureDomain Router
Applicable methods: get_keys, get_entries
SDRName
Description: License log information for specific SecureDomain Router
Parent objects:
SDRNameTable
Keys:
SDRName (mandatory)
Type: BoundedString. Length less than or equal to 32
Description: SDR Name
Value: license_log_sdr
Applicable methods: get_data
Administration
Description: Administration log information
Parent objects:
Log
Child objects:
FeatureIDTable - Feature ID information of license operation log
LocationNumberTable - Location information of license operation log
RequestIDTable - ID information of license operation log
SDRNameTable - Secure Domain Router information of license operation log
Applicable methods: find_data
UDIInformationTable
Description: Unique Device Identifier information
Parent objects:
License
Child objects:
UDIInformation - UDI information on system
Applicable methods: get_keys, get_entries
UDIInformation
Description: UDI information on system
Parent objects:
UDIInformationTable
Keys:
UDI (mandatory)
Type: BoundedString. Length less than or equal to 128
Description: Unique Device Identifier
Value: license_request_udi
Applicable methods: get_data
BackupTable
Description: License backup file information
Parent objects:
License
Child objects:
Backup - License backup file information on system
Applicable methods: get_keys, get_entries
Backup
Description: License backup file information on system
Parent objects:
BackupTable
Keys:
BackupFile (mandatory)
Type: BoundedString. Length less than or equal to 1024
Description: License backup file name
Value: license_backup_info
Applicable methods: get_data
PoolTable
Description: License Pools configuration information
Parent objects:
License
Child objects:
Pool - Pools of configuration information on system
Applicable methods: get_keys, get_entries
Pool
Description: Pools of configuration information on system
Parent objects:
PoolTable
Keys:
PoolName (mandatory)
Type: BoundedString. Length less than or equal to 32
Description: Pool Name
Value: license_pools_info
Applicable methods: get_data
RehostTickets
Description: Rehost Tickets information
Parent objects:
License
Child objects:
FeatureNameTable - Rehost Tickets of featureID information
RackIDTable - Rehost Tickets of RackID information
Applicable methods: find_data
FeatureNameTable
Description: Rehost Tickets of featureID information
Parent objects:
RehostTickets
Child objects:
FeatureName - Rehost Tickets of the featureID information on system
Applicable methods: get_keys, get_entries
FeatureName
Description: Rehost Tickets of the featureID information on system
Parent objects:
FeatureNameTable
Keys:
Feature (mandatory)
Type: BoundedString. Length less than or equal to 31
Description: Feature ID
Value: rehost_feature_info
Applicable methods: get_data
RackIDTable
Description: Rehost Tickets of RackID information
Parent objects:
RehostTickets
Child objects:
RackID - Rehost Tickets of the rackID information on system
Applicable methods: get_keys, get_entries
RackID
Description: Rehost Tickets of the rackID information on system
Parent objects:
RackIDTable
Keys:
Rack (mandatory)
Type: RackID
Description: Rack ID
Value: rehost_rack_info
Applicable methods: get_data
Perl Data Object Documentation for udp_snmp_cfg, version 7. 3.
Objects
UDP_SNMP
Description: UDP SNMP heirarchy point
Parent objects:
Configuration
Child objects:
Trap - Class to hold trap queue and trap timeout
Applicable methods: find_data, set_data, delete_data
Trap
Description: Class to hold trap queue and trap timeout
Parent objects:
UDP_SNMP
Child objects:
QueueLength - The number of traps that can be held
Timeout - Timeout for TRAP message retransmissions
Applicable methods: find_data, set_data, delete_data
QueueLength
Description: The number of traps that can be held
Parent objects:
Trap
Values:
QueueLength (mandatory)
Type: Range. Value lies between 1 and 5000
Description: Queue length
Default value: none.
Applicable methods: get_data, set_data, delete_data
Timeout
Description: Timeout for TRAP message retransmissions
Parent objects:
Trap
Values:
TrapTimeout (mandatory)
Type: Range. Value lies between 1 and 1000
Description: Timeout
Default value: none.
Applicable methods: get_data, set_data, delete_data
Perl Data Object Documentation for ipv4_igmp_action, version 1. 0.
Objects
IGMP
Description: IGMP action data
Task IDs required: multicast
Parent objects:
Action
Child objects:
Clear - Clears IGMP related information
Applicable methods: set_data
Clear
Description: Clears IGMP related information
Parent objects:
IGMP
Child objects:
GroupTable - IGMP clear group data
MRIB - Clear IGMP info from MRIB
TrafficCounters - Clear IGMP traffic counters
Applicable methods: set_data
GroupTable
Description: IGMP clear group data
Parent objects:
Clear
Child objects:
Group - Group to be cleared from IGMP group cache
Applicable methods: set_data
Group
Description: Group to be cleared from IGMP group cache
Parent objects:
GroupTable
Keys:
GroupAddress
Type: IPV4Address
Description: Group address
Name
Type: Interface
Description: Interface Name
Values:
Clear (mandatory)
Type: xsd:boolean
Description: Clear entries for this peer
Default value: none.
Applicable methods: set_data
MRIB
Description: Clear IGMP info from MRIB
Parent objects:
Clear
Values:
Clear (mandatory)
Type: xsd:boolean
Description: Reset connection with MRIB
Default value: none.
Applicable methods: set_data
TrafficCounters
Description: Clear IGMP traffic counters
Parent objects:
Clear
Values:
Clear (mandatory)
Type: xsd:boolean
Description: Clear IGMP traffic counters
Default value: none.
Applicable methods: set_data
Perl Data Object Documentation for infra_pakman_oper, version 1. 0.
Objects
InfraPacketManager
Description: Packet manager infrastructure
Task IDs required: interface
Parent objects:
Operational
Child objects:
NodeTable - List of packet manager nodes
Applicable methods: find_data
NodeTable
Description: List of packet manager nodes
Parent objects:
InfraPacketManager
Child objects:
Node - Packet manager node ID
Applicable methods: get_keys
Node
Description: Packet manager node ID
Parent objects:
NodeTable
Keys:
Node (mandatory)
Type: NodeID
Description: Node ID
Child objects:
Statistics - Packet statistics
Applicable methods: find_data
Statistics
Description: Packet statistics
Parent objects:
Node
Value: pak_show_stats
Applicable methods: get_data
Perl Data Object Documentation for t1e1_cfg, version 1. 0.
Objects
T1E1
Description: Configure T1E1 controller configuration
Task IDs required: sonet-sdh
Parent objects:
InterfaceConfiguration
Child objects:
Bert - Configure T1E1 BERT
Bits - Specify the National Reserved bits for an E1
ChannelGroupTable - Configure channel group on T1E1
ClockSource - Configure t1/e1 TX clock source
DelayClear - Value of Time in milliseconds
DelayTrigger - Value of Time in milliseconds
DwnWhnLooped - Configure t1e1 controller into down-when-looped mode
Framing - Configure T1E1 framing
Linecode - Configure T1E1 linecoding
Loopback - Configure t1e1 loopback mode
Service - Configure mode for the port
T1e1PortCfgFdlAnsi - Enable/Disable FDL
T1e1PortCfgFdlAtt - Enable/Disable FDL
YellowDetection - Yellow Alarm detection
YellowGeneration - Yellow Alarm generation
Applicable methods: find_data, set_data, delete_data
T1e1PortCfgFdlAnsi
Description: Enable/Disable FDL
Task IDs required: sonet-sdh
Parent objects:
T1E1
Values:
T1e1PortCfgFdlAnsi (mandatory)
Type: T1E1CfgFdl
Description: T1 FDL
Default value:
T1e1PortCfgFdlAnsi => disable
Applicable methods: get_data, set_data, delete_data
T1e1PortCfgFdlAtt
Description: Enable/Disable FDL
Task IDs required: sonet-sdh
Parent objects:
T1E1
Values:
T1e1PortCfgFdlAtt (mandatory)
Type: T1E1CfgFdl
Description: T1 FDL
Default value:
T1e1PortCfgFdlAtt => disable
Applicable methods: get_data, set_data, delete_data
Bert
Description: Configure T1E1 BERT
Task IDs required: sonet-sdh
Parent objects:
T1E1
Child objects:
Error - Insert errors into BERT bit stream
Interval - Duration of BERT in minutes
Pattern - BERT pattern
Applicable methods: find_data, set_data, delete_data
Error
Description: Insert errors into BERT bit stream
Task IDs required: sonet-sdh
Parent objects:
Bert
Values:
ID1 (mandatory)
Type: Range. Value lies between 1 and 255
Description: Number of errors to generate (default is 1)
Default value: none.
Applicable methods: get_data, set_data, delete_data
Interval
Description: Duration of BERT in minutes
Task IDs required: sonet-sdh
Parent objects:
Bert
Values:
ID1 (mandatory)
Type: Range. Value lies between 1 and 1440
Description: Duration of BERT in minutes
Default value: none.
Applicable methods: get_data, set_data, delete_data
Pattern
Description: BERT pattern
Task IDs required: sonet-sdh
Parent objects:
Bert
Values:
Pattern (mandatory)
Type: T1E1BertPattern
Description: Bert Pattern
Default value:
Pattern => none
Applicable methods: get_data, set_data, delete_data
ChannelGroupTable
Description: Configure channel group on T1E1
Parent objects:
T1E1
Child objects:
ChannelGroup - channel group number
Applicable methods: get_keys, set_data, delete_data
ChannelGroup
Description: channel group number
Task IDs required: sonet-sdh
Parent objects:
ChannelGroupTable
Keys:
ID1 (mandatory)
Type: Range. Value lies between 0 and 31
Description: channel group number
Child objects:
ChannelGroup_Bert - bert for the channel-group
Speed - speed of the ds0 channel
Timeslots - List of timeslots in the channel group
Applicable methods: find_data, set_data, delete_data
ChannelGroup_Bert
Description: bert for the channel-group
Parent objects:
ChannelGroup
Child objects:
Interval - Duration of BERT in minutes
Pattern - BERT pattern
Applicable methods: find_data, set_data, delete_data
Interval
Description: Duration of BERT in minutes
Task IDs required: sonet-sdh
Parent objects:
ChannelGroup_Bert
Values:
ID1 (mandatory)
Type: Range. Value lies between 1 and 1440
Description: Duration of BERT in minutes
Default value: none.
Applicable methods: get_data, set_data, delete_data
Pattern
Description: BERT pattern
Task IDs required: sonet-sdh
Parent objects:
ChannelGroup_Bert
Values:
Pattern (mandatory)
Type: T1E1BertPattern
Description: Bert Pattern
Default value:
Pattern => none
Applicable methods: get_data, set_data, delete_data
Speed
Description: speed of the ds0 channel
Task IDs required: sonet-sdh
Parent objects:
ChannelGroup
Values:
Speed (mandatory)
Type: T1E1ChSpeed
Description: DS0 channel speed
Default value:
Speed => 64
Applicable methods: get_data, set_data, delete_data
Timeslots
Description: List of timeslots in the channel group
Task IDs required: sonet-sdh
Parent objects:
ChannelGroup
Values:
ID1 (mandatory)
Type: xsd:string
Description: timeslot string seprated by (:) or (-) from 1 to 31. (:) indicates individual timeslot and (-) represent range
Default value: none.
Applicable methods: get_data, set_data, delete_data
ClockSource
Description: Configure t1/e1 TX clock source
Task IDs required: sonet-sdh
Parent objects:
T1E1
Values:
ClockSource (mandatory)
Type: T1E1ClockSource
Description: Clock Source
Default value:
ClockSource => internal
Applicable methods: get_data, set_data, delete_data
Framing
Description: Configure T1E1 framing
Task IDs required: sonet-sdh
Parent objects:
T1E1
Values:
Framing (mandatory)
Type: T1E1Framing
Description: Framing mode
Default value: none.
Applicable methods: get_data, set_data, delete_data
Linecode
Description: Configure T1E1 linecoding
Task IDs required: sonet-sdh
Parent objects:
T1E1
Values:
Linecode (mandatory)
Type: T1E1Linecode
Description: Linecode
Default value: none.
Applicable methods: get_data, set_data, delete_data
Loopback
Description: Configure t1e1 loopback mode
Task IDs required: sonet-sdh
Parent objects:
T1E1
Values:
Loopback (mandatory)
Type: xsd:string
Description: loopback mode:local,remote_line_inband,remote_line_fdl_ansi, remote_line_fdl_bellcore,remote_payload_fdl_ansi,remote_payload_fdl_bellcore,network_linenetwork_payload
Default value: none.
Applicable methods: get_data, set_data, delete_data
Bits
Description: Specify the National Reserved bits for an E1
Task IDs required: sonet-sdh
Parent objects:
T1E1
Values:
ID1 (mandatory)
Type: Range. Value lies between 0 and 31
Description: pattern: 0-0x1f
Default value: none.
Applicable methods: get_data, set_data, delete_data
YellowDetection
Description: Yellow Alarm detection
Task IDs required: sonet-sdh
Parent objects:
T1E1
Values:
YellowDetection (mandatory)
Type: xsd:string
Description: Yellow Alarm detection:enable,disable
Default value: none.
Applicable methods: get_data, set_data, delete_data
YellowGeneration
Description: Yellow Alarm generation
Task IDs required: sonet-sdh
Parent objects:
T1E1
Values:
YellowGeneration (mandatory)
Type: xsd:string
Description: Yellow Alarm generation:enable,disable
Default value: none.
Applicable methods: get_data, set_data, delete_data
Service
Description: Configure mode for the port
Task IDs required: sonet-sdh
Parent objects:
T1E1
Values:
Service (mandatory)
Type: T1E1ServiceType
Description: Configure mode for port
Default value: none.
Applicable methods: get_data, set_data, delete_data
DwnWhnLooped
Description: Configure t1e1 controller into down-when-looped mode
Task IDs required: sonet-sdh
Parent objects:
T1E1
Values:
DwnWhnLooped (mandatory)
Type: T1E1DwnWhnLpedAct
Description: enabled or disabled
Default value: none.
Applicable methods: get_data, set_data, delete_data
DelayTrigger
Description: Value of Time in milliseconds
Task IDs required: sonet-sdh
Parent objects:
T1E1
Values:
ID1 (mandatory)
Type: Range. Value lies between 0 and 60000
Description: Value of Time in milliseconds
Default value:
ID1 => 2500
Applicable methods: get_data, set_data, delete_data
DelayClear
Description: Value of Time in milliseconds
Task IDs required: sonet-sdh
Parent objects:
T1E1
Values:
ID1 (mandatory)
Type: Range. Value lies between 0 and 60000
Description: Value of Time in milliseconds
Default value:
ID1 => 10000
Applicable methods: get_data, set_data, delete_data
Shutdown
Description: Disable T1/E1 controller processing
Task IDs required: sonet-sdh
Parent objects:
InterfaceConfiguration
Values:
ID1 (mandatory)
Type: xsd:boolean
Description: Enabled or disabled
Default value: none.
Applicable methods: get_data, set_data, delete_data
Datatypes
T1E1CfgFdl
Definition: Enumeration. Valid values are:
'disable' - Disabled
'enable' - Enabled
T1E1BertPattern
Definition: Enumeration. Valid values are:
'0s' - All 0's
'1s' - All 1's
'2e15' - 2^15-1 O.151
'2e20' - 2^20-1 O.153
'2e23' - 2^23-1 O.151
'alt-0-1' - Alternating 0's and 1's
'2e20-QRSS' - 2^20-1 QRSS O.151
'1in8' - 1 in 8 pattern
'3in24' - 3 in 24 pattern
'55Daly' - 55 Daly Pattern
'55Octet' - 55 Octet Pattern
'2e11' - 2^11 Pattern
'2e9' - 2^9 Pattern
'ds0-1' - ds0-1 Pattern
'ds0-2' - ds0-2 Pattern
'ds0-3' - ds0-3 Pattern
'ds0-4' - ds0-4 Pattern
'none' - no pattern
T1E1ChSpeed
Definition: Enumeration. Valid values are:
'64' - 64 Kbits
'56' - 56 Kbits
T1E1ClockSource
Definition: Enumeration. Valid values are:
'line' - clock recovered from line
'internal' - internal clock
T1E1Framing
Definition: Enumeration. Valid values are:
'sf' - sf framing mode
'esf' - esf framing mode(T1 default)
'no-crc4' - E1
'crc4' - E1 with CRC(E1 default)
'unframed' - unframed
T1E1Linecode
Definition: Enumeration. Valid values are:
'b8zs' - B8ZS encoding(T1 default)
'ami' - AMI encoding(E1 default)
'hdb3' - HDB3 encoding
T1E1ServiceType
Definition: Enumeration. Valid values are:
'atm' - clear channel carrying atm
T1E1DwnWhnLpedAct
Definition: Enumeration. Valid values are:
'set' - Activate
Perl Data Object Documentation for tty_rs232_cfg, version 1. 1.
Objects
RS232
Description: Configuration specific to Console,Use this class if TTYLine class has a naming 'console'
Task IDs required: tty-access
Parent objects:
TTYLine
Child objects:
Databits - The number of databits.
FlowControl - TTY Line Flow control.
Parity - The parity to be used on the line.
StopBits - The number of stopbits to be used.
Applicable methods: find_data, set_data, delete_data
Databits
Description: The number of databits.
Parent objects:
RS232
Values:
Databits (mandatory)
Type: Range. Value lies between 5 and 8
Description: Number of databits the serial connection should use.
Default value:
Databits => 8
Applicable methods: get_data, set_data, delete_data
FlowControl
Description: TTY Line Flow control.
Parent objects:
RS232
Values:
Direction (mandatory)
Type: TTY_RS232FlowControlDirection
Description: Direction of the flow control
Default value:
Direction => Default
Applicable methods: get_data, set_data, delete_data
Parity
Description: The parity to be used on the line.
Parent objects:
RS232
Values:
Type (mandatory)
Type: TTY_RS232Parity
Description: Type of parity
Default value:
Type => None
Applicable methods: get_data, set_data, delete_data
StopBits
Description: The number of stopbits to be used.
Parent objects:
RS232
Values:
Stopbits (mandatory)
Type: TTY_RS232StopBits
Description: Number of stop bits to be used
Default value:
Stopbits => Two
Applicable methods: get_data, set_data, delete_data
Datatypes
TTY_RS232FlowControlDirection
Definition: Enumeration. Valid values are:
'In' - Inbound flow control
'None' - No flow control
'Out' - Outbound flow control
'Default' - Default flow control
TTY_RS232Parity
Definition: Enumeration. Valid values are:
'Even' - Even parity
'Mark' - Mark parity
'None' - No parity
'Odd' - Odd parity
'Space' - Space parity
TTY_RS232StopBits
Definition: Enumeration. Valid values are:
'One' - One stopbit
'Two' - Two stopbits
Perl Data Object Documentation for te_pce_oper, version 9. 3.
Objects
MPLS_PCE
Description: MPLS PCE operational data
Task IDs required: mpls-te
Parent objects:
Operational
Child objects:
NeighborTable - The set of PCE neighbors
Statistics - PCE stats info
Topology - The topology information in PCE
TunnelsSummary - Summary info of PCE tunnels
Applicable methods: find_data
NeighborTable
Description: The set of PCE neighbors
Parent objects:
MPLS_PCE
Child objects:
Neighbor - The set of PCE neighbors
Applicable methods: get_keys, get_entries
Neighbor
Description: The set of PCE neighbors
Parent objects:
NeighborTable
Keys:
NeighborAddress (mandatory)
Type: IPV4Address
Description: The neighbor address
Value: pce_neighbor_bag
Applicable methods: get_data
Topology
Description: The topology information in PCE
Parent objects:
MPLS_PCE
Child objects:
GlobalInfo - The global information of the overall topology
Applicable methods: find_data
GlobalInfo
Description: The global information of the overall topology
Parent objects:
Topology
Value: pce_topology_global_info_bag
Applicable methods: get_data
Statistics
Description: PCE stats info
Parent objects:
MPLS_PCE
Value: pce_stats_bag
Applicable methods: get_data
TunnelsSummary
Description: Summary info of PCE tunnels
Parent objects:
MPLS_PCE
Value: pce_tunnels_summary_bag
Applicable methods: get_data
Perl Data Object Documentation for ipsla_op_stats_ltst_oper, version 4. 2.
Objects
Latest
Description: Statistics collected during the last sampling cycle of the operation
Parent objects:
Statistics
Child objects:
HopTable - Latest statistics for hops in a path-enabled operation
LPDPathTable - List of latest LPD paths
Target - Latest statistics for the target node
Applicable methods: find_data
Target
Description: Latest statistics for the target node
Parent objects:
Latest
Value: ipsla_global_stats_bag
Applicable methods: get_data
HopTable
Description: Latest statistics for hops in a path-enabled operation
Parent objects:
Latest
Child objects:
Hop - Latest stats for a hop in a path-enabled operation
Applicable methods: get_keys, get_entries
Hop
Description: Latest stats for a hop in a path-enabled operation
Parent objects:
HopTable
Keys:
HopIndex (mandatory)
Type: IPSLAHopIndex
Description: Hop Index
Value: ipsla_global_stats_bag
Applicable methods: get_data
LPDPathTable
Description: List of latest LPD paths
Parent objects:
Latest
Child objects:
LPDPath - Latest path statistics of MPLS LSP group operation
Applicable methods: get_keys, get_entries
LPDPath
Description: Latest path statistics of MPLS LSP group operation
Parent objects:
LPDPathTable
Keys:
PathIndex (mandatory)
Type: IPSLA_LPDPathIndex
Description: LPD path index
Value: ipsla_lpd_path_stats_bag
Applicable methods: get_data
Perl Data Object Documentation for snmp_cfg, version 7. 3.
Objects
SNMP
Description: The heirarchy point for all the SNMP configurations
Task IDs required: snmp
Parent objects:
Configuration
Child objects:
Administration - Container class for SNMP administration
Agent - The heirarchy point for SNMP Agent configurations
ContextTable - List of Context Names
Correlator - Configure properties of the trap correlator
DefaultCommunityMapTable - Container class to hold unencrpted community map
EncryptedCommunityMapTable - Container class to hold clear/encrypted communitie maps
GroupTable - Define a User Security Model group
IPv4 - SNMP TOS bit for outgoing packets
PacketSize - Largest SNMP packet size
System - container to hold system information
Target - SNMP target configurations
Timeouts - SNMP timeouts
TrapHostTable - Specify hosts to receive SNMP notifications
TrapSource - Assign an interface for the source address of all traps
UserTable - Define a user who can access the SNMP engine
VRFAuthenticationTrapDisable - Disable authentication traps for packets on a vrf
VRFTable - SNMP VRF configuration commands
ViewTable - Class to configure a SNMPv2 MIB view
Applicable methods: find_data, set_data, delete_data
IPv4
Description: SNMP TOS bit for outgoing packets
Parent objects:
SNMP
Child objects:
DSCP - DSCP value
Precedence - Precedence value
Applicable methods: find_data, set_data, delete_data
DSCP
Description: DSCP value
Parent objects:
IPv4
Values:
Type
Type: SNMP_DSCP
Description: SNMP TOS type DSCP
Value
Type: SNMP_DSCP_Value
Description: SNMP DSCP value
Default value: none.
Applicable methods: get_data, set_data, delete_data
Precedence
Description: Precedence value
Parent objects:
IPv4
Values:
Type
Type: SNMP_Precedence
Description: SNMP TOS type Precedence
Value
Type: SNMP_Precedence_Value
Description: SNMP Precedence value
Default value: none.
Applicable methods: get_data, set_data, delete_data
Agent
Description: The heirarchy point for SNMP Agent configurations
Parent objects:
SNMP
Child objects:
EngineID - SNMPv3 engineID
Applicable methods: find_data, set_data, delete_data
EngineID
Description: SNMPv3 engineID
Parent objects:
Agent
Child objects:
Local - engineID of the local agent
Applicable methods: find_data, set_data, delete_data
Local
Description: engineID of the local agent
Parent objects:
EngineID
Values:
LocalEngineID (mandatory)
Type: xsd:string
Description: engine ID octet string
Default value: none.
Applicable methods: get_data, set_data, delete_data
Administration
Description: Container class for SNMP administration
Parent objects:
SNMP
Child objects:
DefaultCommunityTable - Container class to hold unencrpted communities
EncryptedCommunityTable - Container class to hold clear/encrypted communities
Applicable methods: find_data, set_data, delete_data
DefaultCommunityTable
Description: Container class to hold unencrpted communities
Parent objects:
Administration
Child objects:
DefaultCommunity - Unencrpted SNMP community string and access priviledges
Applicable methods: get_keys, get_entries, set_data, delete_data
DefaultCommunity
Description: Unencrpted SNMP community string and access priviledges
Parent objects:
DefaultCommunityTable
Keys:
CommunityName (mandatory)
Type: BoundedString. Length less than or equal to 128
Description: SNMP community string
Values:
Priviledge
Type: SNMPAccessLevel
Description: Read/Write Access
ViewName
Type: xsd:string
Description: MIB view to which the community has access
AccessList
Type: xsd:string
Description: Access-list name
Owner
Type: SNMPOwnerAccess
Description: Logical Router or System owner access
Default value: none.
Applicable methods: get_data, set_data, delete_data
EncryptedCommunityTable
Description: Container class to hold clear/encrypted communities
Parent objects:
Administration
Child objects:
EncryptedCommunity - Clear/encrypted SNMP community string and access priviledges
Applicable methods: get_keys, get_entries, set_data, delete_data
EncryptedCommunity
Description: Clear/encrypted SNMP community string and access priviledges
Parent objects:
EncryptedCommunityTable
Keys:
CommunityName (mandatory)
Type: EncryptedString
Description: SNMP community string
Values:
Priviledge
Type: SNMPAccessLevel
Description: Read/Write Access
ViewName
Type: xsd:string
Description: MIB view to which the community has access
AccessList
Type: xsd:string
Description: Access-list name
Owner
Type: SNMPOwnerAccess
Description: Logical Router or System owner access
Default value: none.
Applicable methods: get_data, set_data, delete_data
VRFAuthenticationTrapDisable
Description: Disable authentication traps for packets on a vrf
Parent objects:
SNMP
Values:
Disabled (mandatory)
Type: xsd:boolean
Description: disabled to be set as TRUE
Default value: none.
Applicable methods: get_data, set_data, delete_data
DefaultCommunityMapTable
Description: Container class to hold unencrpted community map
Parent objects:
SNMP
Child objects:
DefaultCommunityMap - Unencrpted SNMP community map name
Applicable methods: get_keys, get_entries, set_data, delete_data
DefaultCommunityMap
Description: Unencrpted SNMP community map name
Parent objects:
DefaultCommunityMapTable
Keys:
CommunityName (mandatory)
Type: BoundedString. Length less than or equal to 128
Description: SNMP community map
Values:
Context
Type: xsd:string
Description: SNMP Context Name
Security
Type: xsd:string
Description: SNMP Security Name
TargetList
Type: xsd:string
Description: target list name
Default value: none.
Applicable methods: get_data, set_data, delete_data
EncryptedCommunityMapTable
Description: Container class to hold clear/encrypted communitie maps
Parent objects:
SNMP
Child objects:
EncryptedCommunityMap - Clear/encrypted SNMP community map
Applicable methods: get_keys, get_entries, set_data, delete_data
EncryptedCommunityMap
Description: Clear/encrypted SNMP community map
Parent objects:
EncryptedCommunityMapTable
Keys:
CommunityName (mandatory)
Type: EncryptedString
Description: SNMP community map
Values:
Context
Type: xsd:string
Description: SNMP Context Name
Security
Type: xsd:string
Description: SNMP Security Name
TargetList
Type: xsd:string
Description: target list name
Default value: none.
Applicable methods: get_data, set_data, delete_data
System
Description: container to hold system information
Parent objects:
SNMP
Child objects:
ChassisID - String to uniquely identify this chassis
Contact - Text for mib Object sysContact
Location - Text for mib Object sysLocation
Applicable methods: find_data, set_data, delete_data
ChassisID
Description: String to uniquely identify this chassis
Parent objects:
System
Values:
ChassisId (mandatory)
Type: BoundedString. Length less than or equal to 255
Description: Chassis ID
Default value: none.
Applicable methods: get_data, set_data, delete_data
Contact
Description: Text for mib Object sysContact
Parent objects:
System
Values:
SystemContact (mandatory)
Type: BoundedString. Length less than or equal to 255
Description: identification of the contact person for this managed node
Default value: none.
Applicable methods: get_data, set_data, delete_data
Location
Description: Text for mib Object sysLocation
Parent objects:
System
Values:
SystemLocation (mandatory)
Type: BoundedString. Length less than or equal to 255
Description: The physical location of this node
Default value: none.
Applicable methods: get_data, set_data, delete_data
GroupTable
Description: Define a User Security Model group
Parent objects:
SNMP
Child objects:
Group - Name of the group
Applicable methods: get_keys, get_entries, set_data, delete_data
Group
Description: Name of the group
Parent objects:
GroupTable
Keys:
Name (mandatory)
Type: BoundedString. Length less than or equal to 128
Description: Name of the group
Values:
SNMPVersion (mandatory)
Type: GroupSNMPVersion
Description: snmp version
SecurityModel
Type: SNMPSecurityModel
Description: security model like auth/noAuth/Priv applicable for v3
NotifyView
Type: xsd:string
Description: notify view name
ReadView
Type: xsd:string
Description: read view name
WriteView
Type: xsd:string
Description: write view name
AccessList
Type: xsd:string
Description: Access-list name
ContextName
Type: xsd:string
Description: Context name
Default value: none.
Applicable methods: get_data, set_data, delete_data
TrapHostTable
Description: Specify hosts to receive SNMP notifications
Parent objects:
SNMP
VRF
Child objects:
TrapHost - Specify hosts to receive SNMP notifications
Applicable methods: get_keys, set_data, delete_data
TrapHost
Description: Specify hosts to receive SNMP notifications
Parent objects:
TrapHostTable
Keys:
IPAddress (mandatory)
Type: IPV4Address
Description: IP address of SNMP notification host
Child objects:
DefaultUserCommunityTable - Container class for defining communities for a trap host
EncryptedUserCommunityTable - Container class for defining Clear/encrypt communities for a trap host
Applicable methods: find_data, set_data, delete_data
DefaultUserCommunityTable
Description: Container class for defining communities for a trap host
Parent objects:
TrapHost
Child objects:
DefaultUserCommunity - Unencrpted Community name associated with a trap host
Applicable methods: get_keys, get_entries, set_data, delete_data
DefaultUserCommunity
Description: Unencrpted Community name associated with a trap host
Parent objects:
DefaultUserCommunityTable
Keys:
CommunityName (mandatory)
Type: BoundedString. Length less than or equal to 128
Description: SNMPv1/v2c community string or SNMPv3 user
Values:
Port
Type: Range. Value lies between 1 and 65535
Description: udp port number
Version (mandatory)
Type: xsd:string
Description: SNMP Version to be used v1/v2c/v3
SecurityLevel
Type: SNMPSecurityModel
Description: Security level to be used noauth/auth/priv
BasicTrapTypes (mandatory)
Type: xsd:unsignedInt
Description: Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
AdvancedTrapTypes1 (mandatory)
Type: xsd:unsignedInt
Description: Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
AdvancedTrapTypes2 (mandatory)
Type: xsd:unsignedInt
Description: Number to signify the feature traps that needs to be setvalue should always to set as 0
Default value: none.
Applicable methods: get_data, set_data, delete_data
EncryptedUserCommunityTable
Description: Container class for defining Clear/encrypt communities for a trap host
Parent objects:
TrapHost
Child objects:
EncryptedUserCommunity - Clear/Encrypt Community name associated with a trap host
Applicable methods: get_keys, get_entries, set_data, delete_data
EncryptedUserCommunity
Description: Clear/Encrypt Community name associated with a trap host
Parent objects:
EncryptedUserCommunityTable
Keys:
CommunityName (mandatory)
Type: EncryptedString
Description: SNMPv1/v2c community string or SNMPv3 user
Values:
Port
Type: Range. Value lies between 1 and 65535
Description: udp port number
Version (mandatory)
Type: xsd:string
Description: SNMP Version to be used v1/v2c/v3
SecurityLevel
Type: SNMPSecurityModel
Description: Security level to be used noauth/auth/priv
BasicTrapTypes (mandatory)
Type: xsd:unsignedInt
Description: Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
AdvancedTrapTypes1 (mandatory)
Type: xsd:unsignedInt
Description: Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
AdvancedTrapTypes2 (mandatory)
Type: xsd:unsignedInt
Description: Number to signify the feature traps that needs to be setvalue should always to set as 0
Default value: none.
Applicable methods: get_data, set_data, delete_data
PacketSize
Description: Largest SNMP packet size
Parent objects:
SNMP
Values:
Size (mandatory)
Type: Range. Value lies between 484 and 65500
Description: Packet size
Default value: none.
Applicable methods: get_data, set_data, delete_data
TrapSource
Description: Assign an interface for the source address of all traps
Parent objects:
SNMP
Values:
IFName (mandatory)
Type: Interface
Description: Interface name
Default value: none.
Applicable methods: get_data, set_data, delete_data
UserTable
Description: Define a user who can access the SNMP engine
Parent objects:
SNMP
Child objects:
User - Name of the user
Applicable methods: get_keys, get_entries, set_data, delete_data
User
Description: Name of the user
Parent objects:
UserTable
Keys:
UserName (mandatory)
Type: xsd:string
Description: Name of the user
Values:
GroupName (mandatory)
Type: xsd:string
Description: Group to which the user belongs
Version (mandatory)
Type: UserSNMPVersion
Description: SNMP version to be used. v1,v2c or v3
AuthenticationPasswordConfigured
Type: xsd:boolean
Description: Flag to indicate that authentication password is configred for version 3
Algorithm
Type: SNMPHashAlgorithm
Description: The algorithm used md5 or sha
AuthenticationPassword
Type: ProprietaryPassword
Description: The authentication password
PrivacyPasswordConfigured
Type: xsd:boolean
Description: Flag to indicate that the privacy password is configured for version 3
PrivacyPassword
Type: ProprietaryPassword
Description: The privacy password
ACLName
Type: xsd:string
Description: Access-list name
Owner
Type: SNMPOwnerAccess
Description: The system access either SDROwner or SystemOwner
Default value: none.
Applicable methods: get_data, set_data, delete_data
ViewTable
Description: Class to configure a SNMPv2 MIB view
Parent objects:
SNMP
Child objects:
View - Name of the view
Applicable methods: get_keys, get_entries, set_data, delete_data
View
Description: Name of the view
Parent objects:
ViewTable
Keys:
ViewName
Type: xsd:string
Description: Name of the view
Family
Type: xsd:string
Description: MIB view family name
Values:
ViewInclusion (mandatory)
Type: SNMP_MIBViewInclusion
Description: MIB view to be included or excluded
Default value: none.
Applicable methods: get_data, set_data, delete_data
Target
Description: SNMP target configurations
Parent objects:
SNMP
Child objects:
TargetListTable - List of targets
Applicable methods: find_data, set_data, delete_data
TargetListTable
Description: List of targets
Parent objects:
Target
Child objects:
TargetList - Name of the target list
Applicable methods: get_keys, set_data, delete_data
TargetList
Description: Name of the target list
Parent objects:
TargetListTable
Keys:
TargetListName (mandatory)
Type: xsd:string
Description: Name of the target list
Child objects:
TargetAddressTable - SNMP Target address configurations
VRFNameTable - List of VRF Name for a target list
Applicable methods: find_data, set_data, delete_data
TargetAddressTable
Description: SNMP Target address configurations
Parent objects:
TargetList
Child objects:
TargetAddress - IP Address to be configured for the Target
Applicable methods: get_keys, get_entries, set_data, delete_data
TargetAddress
Description: IP Address to be configured for the Target
Parent objects:
TargetAddressTable
Keys:
IPAddress (mandatory)
Type: IPV4Address
Description: IPv4 address
Values:
Enable (mandatory)
Type: xsd:boolean
Description: Enable to be set as TRUE to configure an address
Default value: none.
Applicable methods: get_data, set_data, delete_data
VRFNameTable
Description: List of VRF Name for a target list
Parent objects:
TargetList
Child objects:
VRFName - VRF name of the target
Applicable methods: get_keys, get_entries, set_data, delete_data
VRFName
Description: VRF name of the target
Parent objects:
VRFNameTable
Keys:
Name (mandatory)
Type: xsd:string
Description: VRF Name
Values:
Enable (mandatory)
Type: xsd:boolean
Description: Enable to be set as TRUE to configure a VRF
Default value: none.
Applicable methods: get_data, set_data, delete_data
VRFTable
Description: SNMP VRF configuration commands
Parent objects:
SNMP
Child objects:
VRF - VRF name
Applicable methods: get_keys, set_data, delete_data
VRF
Description: VRF name
Parent objects:
VRFTable
Keys:
Name (mandatory)
Type: xsd:string
Description: VRF name
Child objects:
ContextTable - List of Context Names
TrapHostTable - Specify hosts to receive SNMP notifications
Applicable methods: find_data, set_data, delete_data
ContextTable
Description: List of Context Names
Parent objects:
SNMP
VRF
Child objects:
Context - Context Name
Applicable methods: get_keys, get_entries, set_data, delete_data
Context
Description: Context Name
Parent objects:
ContextTable
Keys:
ContextName (mandatory)
Type: xsd:string
Description: Context Name
Values:
Enable (mandatory)
Type: xsd:boolean
Description: Enable to be set as TRUE to create the context
Default value: none.
Applicable methods: get_data, set_data, delete_data
Timeouts
Description: SNMP timeouts
Parent objects:
SNMP
Child objects:
Subagent - Sub-Agent Request timeout
Applicable methods: find_data, set_data, delete_data
Subagent
Description: Sub-Agent Request timeout
Parent objects:
Timeouts
Values:
timeouts (mandatory)
Type: Range. Value lies between 1 and 20
Description: timeout in secs
Default value: none.
Applicable methods: get_data, set_data, delete_data
Datatypes
SNMP_MIBViewInclusion
Definition: Enumeration. Valid values are:
'Included' - MIB View to be included
'Excluded' - MIB View to be excluded
SNMP_DSCP
Definition: Enumeration. Valid values are:
'DSCP' - SNMP TOS type DSCP
SNMP_Precedence
Definition: Enumeration. Valid values are:
'Precedence' - SNMP TOS type Precedence
SNMP_DSCP_Value
Definition: Range with Enumeration. Values must lie between 0 and 63 with well-known values being:
'Default' - Applicable to DSCP: bits 000000
'AF11' - Applicable to DSCP: bits 001010
'AF12' - Applicable to DSCP: bits 001100
'AF13' - Applicable to DSCP: bits 001110
'AF21' - Applicable to DSCP: bits 010010
'AF22' - Applicable to DSCP: bits 010100
'AF23' - Applicable to DSCP: bits 010110
'AF31' - Applicable to DSCP: bits 011010
'AF32' - Applicable to DSCP: bits 011100
'AF33' - Applicable to DSCP: bits 011110
'AF41' - Applicable to DSCP: bits 100010
'AF42' - Applicable to DSCP: bits 100100
'AF43' - Applicable to DSCP: bits 100110
'EF' - Applicable to DSCP: bits 101110
'CS1' - Applicable to DSCP: bits 001000
'CS2' - Applicable to DSCP: bits 010000
'CS3' - Applicable to DSCP: bits 011000
'CS4' - Applicable to DSCP: bits 100000
'CS5' - Applicable to DSCP: bits 101000
'CS6' - Applicable to DSCP: bits 110000
'CS7' - Applicable to DSCP: bits 111000
SNMP_Precedence_Value
Definition: Range with Enumeration. Values must lie between 0 and 7 with well-known values being:
'Routine' - Applicable to Precedence: value 0
'Priority' - Applicable to Precedence: value 1
'Immediate' - Applicable to Precedence: value 2
'Flash' - Applicable to Precedence: value 3
'Flash-override' - Applicable to Precedence: value 4
'Critical' - Applicable to Precedence: value 5
'Internet' - Applicable to Precedence: value 6
'Network' - Applicable to Precedence: value 7
SNMPAccessLevel
Definition: Enumeration. Valid values are:
'ReadOnly' - Read Only Access for a community string
'ReadWrite' - Read Write Access for a community string
SNMPOwnerAccess
Definition: Enumeration. Valid values are:
'SDROwner' - Secure Domain Router Owner permissions
'SystemOwner' - System owner permissions
UserSNMPVersion
Definition: Enumeration. Valid values are:
'V1' - SNMP version 1
'V2C' - SNMP version 2
'V3' - SNMP version 3
GroupSNMPVersion
Definition: Enumeration. Valid values are:
'V1' - SNMP version 1
'V2C' - SNMP version 2
'V3' - SNMP version 3
SNMPSecurityModel
Definition: Enumeration. Valid values are:
'NoAuthentication' - No Authentication required
'Authentication' - Authentication password alone required for access
'Privacy' - Authentication and privacy password required for access
SNMPHashAlgorithm
Definition: Enumeration. Valid values are:
'None' - No authentication required
'MD5' - Standard Message Digest algorithm
'SHA' - SHA algorithm
Perl Data Object Documentation for atm_ilmi_oper, version 3. 0.
Objects
ATM_ILMI
Description: ATM ILMI operational data
Task IDs required: atm
Parent objects:
Operational
Child objects:
NodeTable - Contains all the nodes
Applicable methods: find_data
NodeTable
Description: Contains all the nodes
Parent objects:
ATM_ILMI
Child objects:
Node - The node on which ATM Interfaces are located
Applicable methods: get_keys
Node
Description: The node on which ATM Interfaces are located
Parent objects:
NodeTable
Keys:
node (mandatory)
Type: NodeID
Description: The node id
Child objects:
InterfaceTable - Contains ATM Interface ILMI information for node
Applicable methods: find_data
InterfaceTable
Description: Contains ATM Interface ILMI information for node
Parent objects:
Node
Child objects:
InterfaceName - ATM Interface name
Applicable methods: get_keys, get_entries
InterfaceName
Description: ATM Interface name
Parent objects:
InterfaceTable
Keys:
Interface (mandatory)
Type: Interface
Description: The name of the interface
Value: atm_ilmi_if_config
Applicable methods: get_data
Perl Data Object Documentation for sonet_local_oper, version 1. 4.
Objects
SONET
Description: SONET operational data
Task IDs required: sonet-sdh
Parent objects:
Operational
Child objects:
PortTable - All SONET Port operational data
Applicable methods: find_data
PortTable
Description: All SONET Port operational data
Parent objects:
SONET
Child objects:
Port - SONET Port operational data
Applicable methods: get_keys
Port
Description: SONET Port operational data
Parent objects:
PortTable
Keys:
Name (mandatory)
Type: Interface
Description: Port name
Child objects:
Info - SONET port operational data
Applicable methods: find_data
Info
Description: SONET port operational data
Parent objects:
Port
Value: sonet_port_info
Applicable methods: get_data
Perl Data Object Documentation for lib_keychain_cfg, version 4. 0.
Objects
KeychainTable
Description: Configure a Key Chain
Task IDs required: system
Parent objects:
Configuration
Child objects:
Keychain - Name of the key chain
Applicable methods: get_keys, set_data, delete_data
Keychain
Description: Name of the key chain
Parent objects:
KeychainTable
Keys:
ChainName (mandatory)
Type: xsd:string
Description: Name of the key chain
Child objects:
AcceptTolerance - Accept Tolerance in seconds or infinite
KeyTable - Configure a Key
Applicable methods: find_data, set_data, delete_data
AcceptTolerance
Description: Accept Tolerance in seconds or infinite
Task IDs required: system
Parent objects:
Keychain
Values:
Value
Type: Range. Value lies between 1 and 8640000
Description: Value in seconds
Infinite
Type: xsd:boolean
Description: Infinite tolerance
Default value: none.
Applicable methods: get_data, set_data, delete_data
KeyTable
Description: Configure a Key
Task IDs required: system
Parent objects:
Keychain
Child objects:
Key - Key Identifier
Applicable methods: get_keys, set_data, delete_data
Key
Description: Key Identifier
Task IDs required: system
Parent objects:
KeyTable
Keys:
KeyID (mandatory)
Type: xsd:string
Description: 48-bit Key identifier
Child objects:
AcceptLifetime - Configure a key Acceptance Lifetime
CryptographicAlgorithm - Configure the cryptographic algorithm
KeyString - Configure a clear text/encrypted Key string
SendLifetime - Configure a Send Lifetime
Applicable methods: find_data, set_data, delete_data
CryptographicAlgorithm
Description: Configure the cryptographic algorithm
Task IDs required: system
Parent objects:
Key
Values:
CryptographicAlgorithm (mandatory)
Type: CryptoAlgType
Description: Cryptographic Algorithm
Default value: none.
Applicable methods: get_data, set_data, delete_data
AcceptLifetime
Description: Configure a key Acceptance Lifetime
Task IDs required: system
Parent objects:
Key
Values:
StartHour
Type: Range. Value lies between 0 and 23
Description: Start Hour
StartMinutes
Type: Range. Value lies between 0 and 59
Description: Start Minutes
StartSeconds
Type: Range. Value lies between 0 and 59
Description: Start Seconds
StartDate
Type: Range. Value lies between 1 and 31
Description: Start Date
StartMonth
Type: KeyChainMonthType
Description: Start Month
StartYear
Type: Range. Value lies between 1993 and 2035
Description: Start Year
LifeTime
Type: Range. Value lies between 1 and 2147483647
Description: Lifetime duration in seconds
InfiniteFlag
Type: xsd:boolean
Description: Infinite Lifetime flag
EndHour
Type: Range. Value lies between 0 and 23
Description: End Hour
EndMinutes
Type: Range. Value lies between 0 and 59
Description: End Minutes
EndSeconds
Type: Range. Value lies between 0 and 59
Description: End Seconds
EndDate
Type: Range. Value lies between 1 and 31
Description: End Date
EndMonth
Type: KeyChainMonthType
Description: End Month
EndYear
Type: Range. Value lies between 1993 and 2035
Description: End Year
Default value: none.
Applicable methods: get_data, set_data, delete_data
KeyString
Description: Configure a clear text/encrypted Key string
Task IDs required: system
Parent objects:
Key
Values:
KeyString (mandatory)
Type: ProprietaryPassword
Description: Key String
Default value: none.
Applicable methods: get_data, set_data, delete_data
SendLifetime
Description: Configure a Send Lifetime
Task IDs required: system
Parent objects:
Key
Values:
StartHour
Type: Range. Value lies between 0 and 23
Description: Start Hour
StartMinutes
Type: Range. Value lies between 0 and 59
Description: Start Minutes
StartSeconds
Type: Range. Value lies between 0 and 59
Description: Start Seconds
StartDate
Type: Range. Value lies between 1 and 31
Description: Start Date
StartMonth
Type: KeyChainMonthType
Description: Start Month
StartYear
Type: Range. Value lies between 1993 and 2035
Description: Start Year
LifeTime
Type: Range. Value lies between 1 and 2147483647
Description: Lifetime duration in seconds
InfiniteFlag
Type: xsd:boolean
Description: Infinite Lifetime flag
EndHour
Type: Range. Value lies between 0 and 23
Description: End Hour
EndMinutes
Type: Range. Value lies between 0 and 59
Description: End Minutes
EndSeconds
Type: Range. Value lies between 0 and 59
Description: End Seconds
EndDate
Type: Range. Value lies between 1 and 31
Description: End Date
EndMonth
Type: KeyChainMonthType
Description: End Month
EndYear
Type: Range. Value lies between 1993 and 2035
Description: End Year
Default value: none.
Applicable methods: get_data, set_data, delete_data
Datatypes
KeyChainMonthType
Definition: Enumeration. Valid values are:
'JAN' - January
'FEB' - February
'MAR' - March
'APR' - April
'MAY' - May
'JUN' - June
'JUL' - July
'AUG' - August
'SEP' - September
'OCT' - October
'NOV' - November
'DEC' - December
CryptoAlgType
Definition: Enumeration. Valid values are:
'ALG_HMAC_SHA1_12' - HMAC-SHA-1-12
'ALG_MD5_16' - MD5-16
'ALG_SHA1_20' - SHA-1-20
'ALG_HMAC_MD5_16' - HMAC-MD5-16
'ALG_HMAC_SHA1_20' - HMAC-SHA-1-20
Perl Data Object Documentation for licmgr_adminaction, version 1. 6.
Objects
License
Description: Information of license operations
Task IDs required: sysmgr
Parent objects:
AdminAction
Child objects:
AddTable - Execute license add information
BackupTable - Execute license backup information
Clear - Clear all the installed license
Move - Execute license move information
Pool - License pool action information
Remove - License remove action information
RestoreTable - Execute license restore information
Applicable methods: set_data
AddTable
Description: Execute license add information
Parent objects:
License
Child objects:
Add - Execute license add
Applicable methods: set_data
Add
Description: Execute license add
Parent objects:
AddTable
Keys:
SDRName
Type: BoundedString. Length less than or equal to 32
Description: SDR Name of adding licenses
LicenseFile
Type: xsd:string
Description: Add license file path
Values:
Exec (mandatory)
Type: xsd:boolean
Description: Execute license add
Default value: none.
Applicable methods: set_data
Move
Description: Execute license move information
Parent objects:
License
Child objects:
SDRTable - Execute license move for SDR information
Slot - Execute license move slot information
Applicable methods: set_data
SDRTable
Description: Execute license move for SDR information
Parent objects:
Move
Child objects:
SDR - Execute license move for SDR
Applicable methods: set_data
SDR
Description: Execute license move for SDR
Parent objects:
SDRTable
Keys:
Feature
Type: BoundedString. Length less than or equal to 31
Description: Feature ID
LicenseCount
Type: Range. Value lies between 1 and 1024
Description: Number of licenses to move (1024 is equivalent to the 'all' option)
FromSDRName
Type: BoundedString. Length less than or equal to 32
Description: SDR Name of moving licenses
ToSDRName
Type: BoundedString. Length less than or equal to 32
Description: SDR Name of putting licenses
Values:
Exec (mandatory)
Type: xsd:boolean
Description: Execute license move
Default value: none.
Applicable methods: set_data
Slot
Description: Execute license move slot information
Parent objects:
Move
Child objects:
LocationTable - Location information of license remove
StatusTable - Execute license move the status from allocated to available
Applicable methods: set_data
LocationTable
Description: Location information of license remove
Parent objects:
Slot
Child objects:
Location - Execute license move slot for location
Applicable methods: set_data
Location
Description: Execute license move slot for location
Parent objects:
LocationTable
Keys:
Feature
Type: BoundedString. Length less than or equal to 31
Description: Feature ID
LicenseCount
Type: Range. Value lies between 1 and 1024
Description: Number of licenses to move
FromNode
Type: NodeID
Description: NodeID of moving licenses
ToNode
Type: NodeID
Description: NodeID of putting licenses
Values:
Exec (mandatory)
Type: xsd:boolean
Description: Execute license move slot for location
Default value: none.
Applicable methods: set_data
StatusTable
Description: Execute license move the status from allocated to available
Parent objects:
Slot
Child objects:
Status - Execute license move slot from allocated to available
Applicable methods: set_data
Status
Description: Execute license move slot from allocated to available
Parent objects:
StatusTable
Keys:
Feature (mandatory)
Type: BoundedString. Length less than or equal to 31
Description: Feature ID
Values:
Exec (mandatory)
Type: xsd:boolean
Description: Execute license move slot for the status
Default value: none.
Applicable methods: set_data
Remove
Description: License remove action information
Parent objects:
License
Child objects:
LicenseIDTable - Execute license remove information
TicketTable - Execute license remove information
Applicable methods: set_data
LicenseIDTable
Description: Execute license remove information
Parent objects:
Remove
Child objects:
LicenseID - Execute license remove with licenseID
Applicable methods: set_data
LicenseID
Description: Execute license remove with licenseID
Parent objects:
LicenseIDTable
Keys:
Feature
Type: BoundedString. Length less than or equal to 31
Description: Feature ID
LicenseID
Type: BoundedString. Length less than or equal to 256
Description: License ID
SDRName
Type: BoundedString. Length less than or equal to 32
Description: SDR Name of removing licenses
Values:
Exec (mandatory)
Type: xsd:boolean
Description: Execute license remove with license ID
Default value: none.
Applicable methods: set_data
TicketTable
Description: Execute license remove information
Parent objects:
Remove
Child objects:
Ticket - Execute license remove with the permission tickets
Applicable methods: set_data
Ticket
Description: Execute license remove with the permission tickets
Parent objects:
TicketTable
Keys:
Feature
Type: BoundedString. Length less than or equal to 31
Description: Feature ID
PermissionFile
Type: BoundedString. Length less than or equal to 1024
Description: Permission file path
RehostFile
Type: BoundedString. Length less than or equal to 1024
Description: Rehost file path
SDRName
Type: BoundedString. Length less than or equal to 32
Description: SDR Name of removing licenses
Values:
Exec (mandatory)
Type: xsd:boolean
Description: Execute license remove with ticket
Default value: none.
Applicable methods: set_data
BackupTable
Description: Execute license backup information
Parent objects:
License
Child objects:
Backup - Execute license backup
Applicable methods: set_data
Backup
Description: Execute license backup
Parent objects:
BackupTable
Keys:
BackupFile (mandatory)
Type: xsd:string
Description: Backup license file path
Values:
Exec (mandatory)
Type: xsd:boolean
Description: Execute license backup
Default value: none.
Applicable methods: set_data
RestoreTable
Description: Execute license restore information
Parent objects:
License
Child objects:
Restore - Execute license restore
Applicable methods: set_data
Restore
Description: Execute license restore
Parent objects:
RestoreTable
Keys:
RestoreFile (mandatory)
Type: xsd:string
Description: Restore license file path
Values:
Exec (mandatory)
Type: xsd:boolean
Description: Execute license restore
Default value: none.
Applicable methods: set_data
Pool
Description: License pool action information
Parent objects:
License
Child objects:
CreateSDRTable - Execute license pool create information
RemoveSDRTable - Execute license pool remove information
Applicable methods: set_data
CreateSDRTable
Description: Execute license pool create information
Parent objects:
Pool
Child objects:
CreateSDR - Execute license pool create
Applicable methods: set_data
CreateSDR
Description: Execute license pool create
Parent objects:
CreateSDRTable
Keys:
SDRName (mandatory)
Type: BoundedString. Length less than or equal to 32
Description: SDR Name of creating a pool
Values:
Exec (mandatory)
Type: xsd:boolean
Description: Execute license pool create
Default value: none.
Applicable methods: set_data
RemoveSDRTable
Description: Execute license pool remove information
Parent objects:
Pool
Child objects:
RemoveSDR - Execute license remove
Applicable methods: set_data
RemoveSDR
Description: Execute license remove
Parent objects:
RemoveSDRTable
Keys:
SDRName (mandatory)
Type: BoundedString. Length less than or equal to 32
Description: SDR Name of removing a pool
Values:
Exec (mandatory)
Type: xsd:boolean
Description: Execute license pool remove
Default value: none.
Applicable methods: set_data
Clear
Description: Clear all the installed license
Parent objects:
License
Values:
Clear (mandatory)
Type: xsd:boolean
Description: Clear all the installed license
Default value: none.
Applicable methods: set_data
Perl Data Object Documentation for ip_rsvp_prefix_filtering_cfg, version 3. 2.
Objects
PrefixFiltering
Description: Configure prefix filtering parameters
Parent objects:
Signalling
Child objects:
ACL - Configure an ACL to perform prefix filtering of RSVP Router Alert messages
DefaultDenyAction - Configure RSVP behaviour for scenarios where ACL match yields a default (implicit) deny
Applicable methods: find_data, set_data, delete_data
ACL
Description: Configure an ACL to perform prefix filtering of RSVP Router Alert messages
Parent objects:
PrefixFiltering
Values:
PrefixFilteringACL (mandatory)
Type: BoundedString. Length less than or equal to 33
Description: Name
Default value: none.
Applicable methods: get_data, set_data, delete_data
DefaultDenyAction
Description: Configure RSVP behaviour for scenarios where ACL match yields a default (implicit) deny
Parent objects:
PrefixFiltering
Child objects:
Drop - Drop packets when ACL match yields a default (implicit) deny
Applicable methods: find_data, set_data, delete_data
Drop
Description: Drop packets when ACL match yields a default (implicit) deny
Parent objects:
DefaultDenyAction
Values:
DefaultDenyAction (mandatory)
Type: xsd:boolean
Description: Configure RSVP to drop packets when ACL match yields a default (implicit) deny
Default value: none.
Applicable methods: get_data, set_data, delete_data
Perl Data Object Documentation for mpls_io_cfg, version 1. 0.
Objects
MPLS
Description: MPLS configuration under an interface
Task IDs required: mpls-te or mpls-ldp or mpls-static
Parent objects:
InterfaceConfiguration
Child objects:
MTU - Set the MPLS MTU for the interface
Applicable methods: find_data, set_data, delete_data
MTU
Description: Set the MPLS MTU for the interface
Parent objects:
MPLS
Values:
Size (mandatory)
Type: Range. Value lies between 68 and 65535
Description: MTU size in bytes
Default value: none.
Applicable methods: get_data, set_data, delete_data
Perl Data Object Documentation for ip_tcp_cfg, version 1. 0.
Objects
IP_TCP
Description: Global IP TCP configuration
Task IDs required: transport
Parent objects:
Configuration
Child objects:
MaximumSegmentSize - TCP initial maximum segment size
PathMTUDiscovery - Aging time (in minutes)
SelectiveAck - TCP selective-ACK
SynWaitTime - Time to wait on new TCP connections in seconds
Timestamp - TCP timestamp option
WindowSize - TCP receive window size (bytes)
Applicable methods: find_data, set_data, delete_data
MaximumSegmentSize
Description: TCP initial maximum segment size
Parent objects:
IP_TCP
Values:
SegmentSize (mandatory)
Type: Range. Value lies between 68 and 10000
Description: TCP initial maximum segment size
Default value: none.
Applicable methods: get_data, set_data, delete_data
PathMTUDiscovery
Description: Aging time (in minutes)
Parent objects:
IP_TCP
Values:
AgingTime (mandatory)
Type: xsd:unsignedInt
Description: Aging time; 0 for infinite, and range be (10,30)
Default value:
AgingTime => 10
Applicable methods: get_data, set_data, delete_data
SelectiveAck
Description: TCP selective-ACK
Parent objects:
IP_TCP
Values:
Enable (mandatory)
Type: xsd:boolean
Description: Enable TCP selective-ACK
Default value: none.
Applicable methods: get_data, set_data, delete_data
SynWaitTime
Description: Time to wait on new TCP connections in seconds
Parent objects:
IP_TCP
Values:
SynWait (mandatory)
Type: Range. Value lies between 5 and 30
Description: Wait time
Default value: none.
Applicable methods: get_data, set_data, delete_data
Timestamp
Description: TCP timestamp option
Parent objects:
IP_TCP
Values:
Enable (mandatory)
Type: xsd:boolean
Description: Enable TCP timestamp option
Default value: none.
Applicable methods: get_data, set_data, delete_data
WindowSize
Description: TCP receive window size (bytes)
Parent objects:
IP_TCP
Values:
WindowSize (mandatory)
Type: Range. Value lies between 2048 and 65535
Description: Window size
Default value: none.
Applicable methods: get_data, set_data, delete_data
Perl Data Object Documentation for mda_common_cfg, version 1. 1.
Objects
ActiveNodeTable
Description: Per-node configuration for active nodes
Parent objects:
Configuration
Child objects:
ActiveNode - The configuration for an active node
Applicable methods: get_keys, set_data, delete_data
ActiveNode
Description: The configuration for an active node
Parent objects:
ActiveNodeTable
Keys:
NodeID (mandatory)
Type: NodeID
Description: The identifier for this node
Applicable methods: find_data, set_data, delete_data
PreconfiguredNodeTable
Description: Per-node configuration for non-active nodes
Parent objects:
Configuration
Child objects:
PreconfiguredNode - The configuration for a non-active node
Applicable methods: get_keys, set_data, delete_data
PreconfiguredNode
Description: The configuration for a non-active node
Parent objects:
PreconfiguredNodeTable
Keys:
NodeID (mandatory)
Type: NodeID
Description: The identifier for this node
Applicable methods: find_data, set_data, delete_data
Perl Data Object Documentation for ipsla_op_def_udp_echo_cfg, version 7. 2.
Objects
UDPEcho
Description: UDPEcho Operation type
Parent objects:
OperationType
Child objects:
ControlDisable - Disable control packets
Create - Create operation with specified type
DataSize - Protocol data size in payload of probe packets
DestAddress - IPv4 address of the target device
DestPort - Port number on target device
EnhancedStatsTable - Table of statistics collection intervals
Frequency - Frequency of the probing
History - Configure the history parameters for this operation
SourceAddress - IPv4 address of the source device
SourcePort - Port number on source device
Statistics - Statistics collection aggregated over an hour
Tag - Add a tag for this operation
Timeout - Probe/Control timeout interval
Tos - Type of service setting in probe packet
VRF - Configure IPSLA for a VPN Routing/Forwarding instance)
VerifyData - Check each IPSLA response for corruption
Applicable methods: find_data, set_data, delete_data
DataSize
Description: Protocol data size in payload of probe packets
Parent objects:
UDPEcho
Child objects:
Request - Payload size in request probe packet
Applicable methods: find_data, set_data, delete_data
Request
Description: Payload size in request probe packet
Parent objects:
DataSize
Values:
RequestDataSize (mandatory)
Type: Range. Value lies between 4 and 1500
Description: Request data size in bytes
Default value:
RequestDataSize => 16
Applicable methods: get_data, set_data, delete_data
Perl Data Object Documentation for tty_management_cfg, version 1. 1.
Objects
Connection
Description: Management connection configuration
Task IDs required: tty-access
Parent objects:
TTYLine
Child objects:
ACLIn - ACL to filter ingoing connections
ACLOut - ACL to filter outgoing connections
CLIWhiteSpaceCompletion - Command completion on whitespace
DisconnectCharacter - The line disconnect character
EscapeCharacter - Line template's escape character
SessionLimit - The number of outgoing connections
SessionTimeout - Interval for closing connection when there is no input traffic
TransportInput - Protocols to use when connecting to the terminal server
TransportOutput - Protocols to use for outgoing connections
TransportPreferred - The preferred protocol to use
Applicable methods: find_data, set_data, delete_data
ACLIn
Description: ACL to filter ingoing connections
Parent objects:
Connection
Values:
ACLName (mandatory)
Type: xsd:string
Description: IP access list name
Default value: none.
Applicable methods: get_data, set_data, delete_data
ACLOut
Description: ACL to filter outgoing connections
Parent objects:
Connection
Values:
ACLName (mandatory)
Type: xsd:string
Description: IP access list name
Default value: none.
Applicable methods: get_data, set_data, delete_data
DisconnectCharacter
Description: The line disconnect character
Parent objects:
Connection
Values:
Character (mandatory)
Type: CharNum
Description: Disconnect character's decimal equivalent value or Character
Default value: none.
Applicable methods: get_data, set_data, delete_data
EscapeCharacter
Description: Line template's escape character
Parent objects:
Connection
Values:
TTYEscape (mandatory)
Type: TTYEscapeCharNum
Description: Escape character or ASCII decimal equivalent value orspecial strings NONE,DEFAULT,BREAK
Default value:
TTYEscape => 30
Applicable methods: get_data, set_data, delete_data
CLIWhiteSpaceCompletion
Description: Command completion on whitespace
Parent objects:
Connection
Values:
Enabled (mandatory)
Type: xsd:boolean
Description: True to enable
Default value: none.
Applicable methods: get_data, set_data, delete_data
SessionLimit
Description: The number of outgoing connections
Parent objects:
Connection
Values:
Connections (mandatory)
Type: Range. Value lies between 0 and 20
Description: Number of outgoing connections
Default value:
Connections => 6
Applicable methods: get_data, set_data, delete_data
SessionTimeout
Description: Interval for closing connection when there is no input traffic
Parent objects:
Connection
Values:
Timeout (mandatory)
Type: Range. Value lies between 0 and 35791
Description: Session timeout interval in minutes
Direction (mandatory)
Type: TTYSessionTimeoutDirection
Description: Include output traffic as well as input traffic
Default value:
Timeout => 10
Direction => 1
Applicable methods: get_data, set_data, delete_data
TransportInput
Description: Protocols to use when connecting to the terminal server
Parent objects:
Connection
Values:
Select
Type: TTYTransportProtocolSelect
Description: Choose transport protocols
Protocol1
Type: TTYTransportProtocol
Description: Transport protocol1
Protocol2
Type: TTYTransportProtocol
Description: Transport protocol2
None
Type: xsd:unsignedInt
Description: Not used
Default value:
Select => 1
Protocol1 => null
Protocol2 => null
None => null
Applicable methods: get_data, set_data, delete_data
TransportOutput
Description: Protocols to use for outgoing connections
Parent objects:
Connection
Values:
Select (mandatory)
Type: TTYTransportProtocolSelect
Description: Choose transport protocols
Protocol1
Type: TTYTransportProtocol
Description: Transport protocol1
Protocol2
Type: TTYTransportProtocol
Description: Transport protocol2
None
Type: xsd:unsignedInt
Description: Not used
Default value:
Select => 1
Protocol1 => null
Protocol2 => null
None => null
Applicable methods: get_data, set_data, delete_data
TransportPreferred
Description: The preferred protocol to use
Parent objects:
Connection
Values:
Protocol (mandatory)
Type: TTYTransportProtocol
Description: Preferred transport protocol
Default value: none.
Applicable methods: get_data, set_data, delete_data
Perl Data Object Documentation for parser_cfg, version 0. 0.
Objects
Parser
Description: Parser configuration
Parent objects:
Configuration
Child objects:
Alias - Alias for command mapping
Applicable methods: find_data, set_data, delete_data
Perl Data Object Documentation for mpls_oam_cfg, version 0. 0.
Objects
MPLS_OAM
Description: MPLS LSP verification configuration
Task IDs required: mpls-te or mpls-ldp or mpls-static
Parent objects:
Configuration
Child objects:
DefaultRevision - Echo request default revision
DisableVendorExtension - Disable vendor extension
EnableOAM - Enable/Disable MPLS OAM globally.Without creating this object the MPLS OAM feature will not be enabled. Deleting this object will stop the MPLS OAM feature.
Applicable methods: find_data, set_data, delete_data
EnableOAM
Description: Enable/Disable MPLS OAM globally.Without creating this object the MPLS OAM feature will not be enabled. Deleting this object will stop the MPLS OAM feature.
Parent objects:
MPLS_OAM
Values:
Configured (mandatory)
Type: xsd:boolean
Description: Always set to TRUE
Default value: none.
Applicable methods: get_data, set_data, delete_data
DisableVendorExtension
Description: Disable vendor extension
Parent objects:
MPLS_OAM
Values:
Configured (mandatory)
Type: xsd:boolean
Description: Always set to TRUE
Default value: none.
Applicable methods: get_data, set_data, delete_data
DefaultRevision
Description: Echo request default revision
Parent objects:
MPLS_OAM
Values:
Revision (mandatory)
Type: MPLS_OAMRevisionType
Description: Echo request default revision
Default value:
Revision => Draft09Initial
Applicable methods: get_data, set_data, delete_data
Datatypes
MPLS_OAMRevisionType
Definition: Enumeration. Valid values are:
'Draft03Initial' - draft-ietf-mpls-lsp-ping-03 (initial)
'Draft03Revision1' - draft-ietf-mpls-lsp-ping-03 (revision 1)
'Draft03Revision2' - draft-ietf-mpls-lsp-ping-03 (revision 2)
'Draft09Initial' - draft-ietf-mpls-lsp-ping-09 (initial)
Perl Data Object Documentation for pmengine_ui_cfg, version 1. 0.
Objects
PerformanceManagement
Description: Configure pm parameters
Parent objects:
InterfaceConfiguration
Child objects:
Hour24 - Configure pm parameters of 24 hour interval
Minute15 - set opr min threshold
Applicable methods: find_data, set_data, delete_data
Hour24
Description: Configure pm parameters of 24 hour interval
Parent objects:
PerformanceManagement
Child objects:
Hour24FEC - Configure fec g709 performance monitoring
Hour24OTN - configure otn g709 performance monitoring
Hour24Optics - Configure optics performance monitoring
Applicable methods: find_data, set_data, delete_data
Hour24FEC
Description: Configure fec g709 performance monitoring
Parent objects:
Hour24
Child objects:
Hour24FECReportTable - set fec TCA reporting status
Hour24FECThresholdTable - Configure fec threshold
Applicable methods: find_data, set_data, delete_data
Hour24FECReportTable
Description: set fec TCA reporting status
Parent objects:
Hour24FEC
Child objects:
Hour24FECReport - none
Applicable methods: get_keys, get_entries, set_data, delete_data
Hour24FECReport
Description: none
Task IDs required: dwdm
Parent objects:
Hour24FECReportTable
Keys:
FECReport (mandatory)
Type: FecReportType
Description: Fec Report type
Values:
Enable (mandatory)
Type: xsd:boolean
Description: Enabled Fec Report
Default value: none.
Applicable methods: get_data, set_data, delete_data
Hour24FECThresholdTable
Description: Configure fec threshold
Parent objects:
Hour24FEC
Child objects:
Hour24FECThreshold - none
Applicable methods: get_keys, get_entries, set_data, delete_data
Hour24FECThreshold
Description: none
Task IDs required: dwdm
Parent objects:
Hour24FECThresholdTable
Keys:
FECThreshold (mandatory)
Type: FecThresholdType
Description: Fec Threshold Type
Values:
FecThresholdValue (mandatory)
Type: xsd:unsignedInt
Description: Fec threshold value
Default value: none.
Applicable methods: get_data, set_data, delete_data
Hour24Optics
Description: Configure optics performance monitoring
Parent objects:
Hour24
Child objects:
Hour24OpticsReportTable - set optics TCA reporting status
Hour24OpticsThresholdTable - Configure threshold on optics parameters
Applicable methods: find_data, set_data, delete_data
Hour24OpticsReportTable
Description: set optics TCA reporting status
Parent objects:
Hour24Optics
Child objects:
Hour24OpticsReport - none
Applicable methods: get_keys, get_entries, set_data, delete_data
Hour24OpticsReport
Description: none
Task IDs required: dwdm
Parent objects:
Hour24OpticsReportTable
Keys:
OpticsReport (mandatory)
Type: OpticsReportType
Description: Optics Report Type
Values:
Enable (mandatory)
Type: xsd:boolean
Description: Enabled Optics Report
Default value: none.
Applicable methods: get_data, set_data, delete_data
Hour24OpticsThresholdTable
Description: Configure threshold on optics parameters
Parent objects:
Hour24Optics
Child objects:
Hour24OpticsThreshold - none
Applicable methods: get_keys, get_entries, set_data, delete_data
Hour24OpticsThreshold
Description: none
Task IDs required: dwdm
Parent objects:
Hour24OpticsThresholdTable
Keys:
OpticsThreshold (mandatory)
Type: OpticsThresholdType
Description: Optics Threshold Type
Values:
OpticsThresholdValue (mandatory)
Type: xsd:unsignedInt
Description: Optics Thresh Value
Default value: none.
Applicable methods: get_data, set_data, delete_data
Hour24OTN
Description: configure otn g709 performance monitoring
Parent objects:
Hour24
Child objects:
Hour24OTNReportTable - set otn TCA reporting status
Hour24OTNThresholdTable - Configure threshold on otn parameters
Applicable methods: find_data, set_data, delete_data
Hour24OTNReportTable
Description: set otn TCA reporting status
Parent objects:
Hour24OTN
Child objects:
Hour24OTNReport - none
Applicable methods: get_keys, get_entries, set_data, delete_data
Hour24OTNReport
Description: none
Task IDs required: dwdm
Parent objects:
Hour24OTNReportTable
Keys:
OTNReport (mandatory)
Type: OtnReportType
Description: Otn Report Type
Values:
Enable (mandatory)
Type: xsd:boolean
Description: Enabled Otn Report
Default value: none.
Applicable methods: get_data, set_data, delete_data
Hour24OTNThresholdTable
Description: Configure threshold on otn parameters
Parent objects:
Hour24OTN
Child objects:
Hour24OTNThreshold - none
Applicable methods: get_keys, get_entries, set_data, delete_data
Hour24OTNThreshold
Description: none
Task IDs required: dwdm
Parent objects:
Hour24OTNThresholdTable
Keys:
OTNThreshold (mandatory)
Type: OtnThresholdType
Description: Otn Threshold Type
Values:
OtnThresholdValue (mandatory)
Type: xsd:unsignedInt
Description: Otn Threshold Value
Default value: none.
Applicable methods: get_data, set_data, delete_data
Minute15
Description: set opr min threshold
Parent objects:
PerformanceManagement
Child objects:
Minute15FEC - Configure fec g709 performance monitoring
Minute15OTN - configure otn g709 performance monitoring
Minute15Optics - Configure optics performance monitoring
Applicable methods: find_data, set_data, delete_data
Minute15FEC
Description: Configure fec g709 performance monitoring
Parent objects:
Minute15
Child objects:
Minute15FECReportTable - set fec TCA reporting status
Minute15FECThresholdTable - Configure fec threshold
Applicable methods: find_data, set_data, delete_data
Minute15FECReportTable
Description: set fec TCA reporting status
Parent objects:
Minute15FEC
Child objects:
Minute15FECReport - none
Applicable methods: get_keys, get_entries, set_data, delete_data
Minute15FECReport
Description: none
Task IDs required: dwdm
Parent objects:
Minute15FECReportTable
Keys:
FECReport (mandatory)
Type: FecReportType
Description: Fec Report Type
Values:
Enable (mandatory)
Type: xsd:boolean
Description: Enabled Fec Report
Default value: none.
Applicable methods: get_data, set_data, delete_data
Minute15FECThresholdTable
Description: Configure fec threshold
Parent objects:
Minute15FEC
Child objects:
Minute15FECThreshold - none
Applicable methods: get_keys, get_entries, set_data, delete_data
Minute15FECThreshold
Description: none
Task IDs required: dwdm
Parent objects:
Minute15FECThresholdTable
Keys:
FECThreshold (mandatory)
Type: FecThresholdType
Description: Fec Threshold Type
Values:
FecThresholdValue (mandatory)
Type: xsd:unsignedInt
Description: Fec Threshold Value
Default value: none.
Applicable methods: get_data, set_data, delete_data
Minute15Optics
Description: Configure optics performance monitoring
Parent objects:
Minute15
Child objects:
Minute15OpticsReportTable - set optics TCA reporting status
Minute15OpticsThresholdTable - Configure threshold on optics parameters
Applicable methods: find_data, set_data, delete_data
Minute15OpticsReportTable
Description: set optics TCA reporting status
Parent objects:
Minute15Optics
Child objects:
Minute15OpticsReport - none
Applicable methods: get_keys, get_entries, set_data, delete_data
Minute15OpticsReport
Description: none
Task IDs required: dwdm
Parent objects:
Minute15OpticsReportTable
Keys:
OpticsReport (mandatory)
Type: OpticsReportType
Description: Optics Report Type
Values:
Enable (mandatory)
Type: xsd:boolean
Description: Enabled Optics Report
Default value: none.
Applicable methods: get_data, set_data, delete_data
Minute15OpticsThresholdTable
Description: Configure threshold on optics parameters
Parent objects:
Minute15Optics
Child objects:
Minute15OpticsThreshold - none
Applicable methods: get_keys, get_entries, set_data, delete_data
Minute15OpticsThreshold
Description: none
Task IDs required: dwdm
Parent objects:
Minute15OpticsThresholdTable
Keys:
OpticsThreshold (mandatory)
Type: OpticsThresholdType
Description: Optics Threshold Type
Values:
OpticsThresholdValue (mandatory)
Type: xsd:unsignedInt
Description: Optics Threshold Value
Default value: none.
Applicable methods: get_data, set_data, delete_data
Minute15OTN
Description: configure otn g709 performance monitoring
Parent objects:
Minute15
Child objects:
Minute15OTNReportTable - set otn TCA reporting status
Minute15OTNThresholdTable - Configure threshold on otn parameters
Applicable methods: find_data, set_data, delete_data
Minute15OTNReportTable
Description: set otn TCA reporting status
Parent objects:
Minute15OTN
Child objects:
Minute15OTNReport - none
Applicable methods: get_keys, get_entries, set_data, delete_data
Minute15OTNReport
Description: none
Task IDs required: dwdm
Parent objects:
Minute15OTNReportTable
Keys:
OTNReport (mandatory)
Type: OtnReportType
Description: Otn Report Type
Values:
Enable (mandatory)
Type: xsd:boolean
Description: Enabled Otn Report
Default value: none.
Applicable methods: get_data, set_data, delete_data
Minute15OTNThresholdTable
Description: Configure threshold on otn parameters
Parent objects:
Minute15OTN
Child objects:
Min15OtnThresh - none
Applicable methods: get_keys, get_entries, set_data, delete_data
Min15OtnThresh
Description: none
Task IDs required: dwdm
Parent objects:
Minute15OTNThresholdTable
Keys:
OTNThreshold (mandatory)
Type: OtnThresholdType
Description: Otn Threshold Type
Values:
OtnThresholdValue (mandatory)
Type: xsd:unsignedInt
Description: Otn Threshold Value
Default value: none.
Applicable methods: get_data, set_data, delete_data
Datatypes
FecReportType
Definition: Enumeration. Valid values are:
'REPORT_EC_BITS' - PM Fec ec bits report
'REPORT_UC_WORDS' - PM Fec uc words report
FecThresholdType
Definition: Enumeration. Valid values are:
'THRESH_EC_BITS' - PM Fec ec bits threshold
'THRESH_UC_WORDS' - PM Fec uc words threshold
OtnThresholdType
Definition: Enumeration. Valid values are:
'THRESH_ES_SM_NE' - PM Otn es sm ne threshold
'THRESH_SES_SM_NE' - PM Otn ses sm ne threshold
'THRESH_UAS_SM_NE' - PM Otn uas sm ne threshold
'THRESH_BBE_SM_NE' - PM Otn bbe sm ne threshold
'THRESH_FC_SM_NE' - PM Otn fc sm ne threshold
'THRESH_ESR_SM_NE' - PM Otn esr sm ne threshold
'THRESH_SESR_SM_NE' - PM Otn sesr sm ne threshold
'THRESH_BBER_SM_NE' - PM Otn bber sm ne threshold
'THRESH_ES_PM_NE' - PM Otn es pm ne threshold
'THRESH_SES_PM_NE' - PM Otn ses pm ne threshold
'THRESH_UAS_PM_NE' - PM Otn uas pm ne threshold
'THRESH_BBE_PM_NE' - PM Otn bbe pm ne threshold
'THRESH_FC_PM_NE' - PM Otn fc pm ne threshold
'THRESH_ESR_PM_NE' - PM Otn esr pm ne threshold
'THRESH_SESR_PM_NE' - PM Otn sesr pm ne threshold
'THRESH_BBER_PM_NE' - PM Otn bber pm ne threshold
'THRESH_ES_SM_FE' - PM Otn es sm fe threshold
'THRESH_SES_SM_FE' - PM Otn ses sm fe threshold
'THRESH_UAS_SM_FE' - PM Otn uas sm fe threshold
'THRESH_BBE_SM_FE' - PM Otn bbe sm fe threshold
'THRESH_FC_SM_FE' - PM Otn fc sm fe threshold
'THRESH_ESR_SM_FE' - PM Otn esr sm fe threshold
'THRESH_SESR_SM_FE' - PM Otn sesr sm fe threshold
'THRESH_BBER_SM_FE' - PM Otn bber sm fe threshold
'THRESH_ES_PM_FE' - PM Otn es pm fe threshold
'THRESH_SES_PM_FE' - PM Otn ses pm fe threshold
'THRESH_UAS_PM_FE' - PM Otn uas pm fe threshold
'THRESH_BBE_PM_FE' - PM Otn bbe pm fe threshold
'THRESH_FC_PM_FE' - PM Otn fc pm fe threshold
'THRESH_ESR_PM_FE' - PM Otn esr pm fe threshold
'THRESH_SESR_PM_FE' - PM Otn sesr pm fe threshold
'THRESH_BBER_PM_FE' - PM Otn bber pm fe threshold
OtnReportType
Definition: Enumeration. Valid values are:
'REPORT_ES_SM_NE' - PM Otn es sm ne report
'REPORT_SES_SM_NE' - PM Otn ses sm ne report
'REPORT_UAS_SM_NE' - PM Otn uas sm ne report
'REPORT_BBE_SM_NE' - PM Otn bbe sm ne report
'REPORT_FC_SM_NE' - PM Otn fc sm ne report
'REPORT_ESR_SM_NE' - PM Otn esr sm ne report
'REPORT_SESR_SM_NE' - PM Otn sesr sm ne report
'REPORT_BBER_SM_NE' - PM Otn bber sm ne report
'REPORT_ES_PM_NE' - PM Otn es pm ne report
'REPORT_SES_PM_NE' - PM Otn ses pm ne report
'REPORT_UAS_PM_NE' - PM Otn uas pm ne report
'REPORT_BBE_PM_NE' - PM Otn bbe pm ne report
'REPORT_FC_PM_NE' - PM Otn fc pm ne report
'REPORT_ESR_PM_NE' - PM Otn esr pm ne report
'REPORT_SESR_PM_NE' - PM Otn sesr pm ne report
'REPORT_BBER_PM_NE' - PM Otn bber pm ne report
'REPORT_ES_SM_FE' - PM Otn es sm fe report
'REPORT_SES_SM_FE' - PM Otn ses sm fe report
'REPORT_UAS_SM_FE' - PM Otn uas sm fe report
'REPORT_BBE_SM_FE' - PM Otn bbe sm fe report
'REPORT_FC_SM_FE' - PM Otn fc sm fe report
'REPORT_ESR_SM_FE' - PM Otn esr sm fe report
'REPORT_SESR_SM_FE' - PM Otn sesr sm fe report
'REPORT_BBER_SM_FE' - PM Otn bber sm fe report
'REPORT_ES_PM_FE' - PM Otn es pm fe report
'REPORT_SES_PM_FE' - PM Otn ses pm fe report
'REPORT_UAS_PM_FE' - PM Otn uas pm fe report
'REPORT_BBE_PM_FE' - PM Otn bbe pm fe report
'REPORT_FC_PM_FE' - PM Otn fc pm fe report
'REPORT_ESR_PM_FE' - PM Otn esr pm fe report
'REPORT_SESR_PM_FE' - PM Otn sesr pm fe report
'REPORT_BBER_PM_FE' - PM Otn bber pm fe report
OpticsThresholdType
Definition: Enumeration. Valid values are:
'THRESH_LBC_MIN' - PM Optics lbc min threshold
'THRESH_LBC_MAX' - PM Optics lbc max threshold
'THRESH_OPT_MIN' - PM Optics opt min threshold
'THRESH_OPT_MAX' - PM Optics opt max threshold
'THRESH_OPR_MIN' - PM Optics opr min threshold
'THRESH_OPR_MAX' - PM Optics opr max threshold
OpticsReportType
Definition: Enumeration. Valid values are:
'REPORT_LBC_MIN' - PM Optics lbc min report
'REPORT_LBC_MAX' - PM Optics lbc max report
'REPORT_OPT_MIN' - PM Optics opt min report
'REPORT_OPT_MAX' - PM Optics opt max report
'REPORT_OPR_MIN' - PM Optics opr min report
'REPORT_OPR_MAX' - PM Optics opr max report
Perl Data Object Documentation for mpls_lcac_cfg, version 12. 3.
Objects
LCAC
Description: LCAC specific MPLS global configuration
Parent objects:
MPLS_TE
Child objects:
BFD - BFD configuration
BandwidthHoldTimer - Bandwidth hold timer
PeriodicFloodingTimer - Periodic flooding timer
ReoptimizeDelayCleanupTimer - Reoptimization delay cleanup timer
ReoptimizeDelayInstallTimer - Reoptimize delay install timer
Applicable methods: find_data, set_data, delete_data
BandwidthHoldTimer
Description: Bandwidth hold timer
Parent objects:
LCAC
Values:
Value (mandatory)
Type: MPLS_LCACBandwidthHoldTimerRange
Description: Bandwidth hold timer value (seconds)
Default value: none.
Applicable methods: get_data, set_data, delete_data
PeriodicFloodingTimer
Description: Periodic flooding timer
Parent objects:
LCAC
Values:
Value (mandatory)
Type: Range. Value lies between 30 and 3600
Description: Periodic flooding value (seconds)
Default value: none.
Applicable methods: get_data, set_data, delete_data
ReoptimizeDelayInstallTimer
Description: Reoptimize delay install timer
Parent objects:
LCAC
Values:
Value (mandatory)
Type: Range. Value lies between 0 and 3600
Description: Reoptimization Delay Install Value (seconds)
Default value: none.
Applicable methods: get_data, set_data, delete_data
ReoptimizeDelayCleanupTimer
Description: Reoptimization delay cleanup timer
Parent objects:
LCAC
Values:
Value (mandatory)
Type: Range. Value lies between 0 and 300
Description: Reoptimization Delay Cleanup Value (seconds)
Default value: none.
Applicable methods: get_data, set_data, delete_data
BFD
Description: BFD configuration
Parent objects:
LCAC
Child objects:
DetectionMultiplier - Detection multiplier for BFD sessions created by TE
Interval - Hello interval for BFD sessions created by TE
Applicable methods: find_data, set_data, delete_data
Interval
Description: Hello interval for BFD sessions created by TE
Parent objects:
BFD
Values:
Interval (mandatory)
Type: Range. Value lies between 15 and 200
Description: BFD hello interval in milliseconds
Default value: none.
Applicable methods: get_data, set_data, delete_data
DetectionMultiplier
Description: Detection multiplier for BFD sessions created by TE
Parent objects:
BFD
Values:
Multiplier (mandatory)
Type: Range. Value lies between 2 and 10
Description: BFD multiplier
Default value: none.
Applicable methods: get_data, set_data, delete_data
Datatypes
MPLS_LCACBandwidthHoldTimerRange
Definition: Range. Value lies between 1 and 300
Perl Data Object Documentation for ether_gl_feature_cfg, version 3. 0.
Objects
EthernetFeatures
Description: Ethernet Features Configuration
Task IDs required: ethernet-services
Parent objects:
Configuration
Applicable methods: find_data, set_data, delete_data
Perl Data Object Documentation for ipv4_multicast_sap_oper, version 1. 0.
Objects
SAP
Description: SAP operational data
Task IDs required: multicast
Parent objects:
Operational
Child objects:
SessionInfoSummaryTable - SAP Session Summary Table
SessionInfoTable - SAP Session Table
Applicable methods: find_data
SessionInfoSummaryTable
Description: SAP Session Summary Table
Parent objects:
SAP
Child objects:
SessionInfoSummary - SAP Session Summary Entry
Applicable filters:
SAPGroupFilter
SAPSessionNameFilter
Applicable methods: get_keys, get_entries
SessionInfoSummary
Description: SAP Session Summary Entry
Parent objects:
SessionInfoSummaryTable
Keys:
SessionName
Type: xsd:string
Description: Session Name
SessionOwner
Type: xsd:string
Description: Session Owner
Value: sap_bag_summary
Applicable methods: get_data
SessionInfoTable
Description: SAP Session Table
Parent objects:
SAP
Child objects:
SessionInfo - SAP Session Entry
Applicable filters:
SAPGroupFilter
SAPSessionNameFilter
Applicable methods: get_keys, get_entries
SessionInfo
Description: SAP Session Entry
Parent objects:
SessionInfoTable
Keys:
SessionName
Type: xsd:string
Description: Session Name
SessionOwner
Type: xsd:string
Description: Session Owner
Value: sap_bag
Applicable methods: get_data
Filters
SAPGroupFilter
Description: Filter based on Announcement Group
Parameters:
Group (mandatory)
Type: IPV4Address
Description: Group Address
SAPSessionNameFilter
Description: Filter based on Session Name
Parameters:
Name (mandatory)
Type: xsd:string
Description: Session Name
Perl Data Object Documentation for netflow_crs_cfg, version 3. 0.
Objects
NetFlow
Description: NetFlow Configuration
Task IDs required: netflow
Parent objects:
Configuration
Child objects:
FlowExporterMapTable - Configure a flow exporter map
FlowMonitorMapTable - Flow monitor map configuration
FlowSamplerMapTable - Flow sampler map configuration
Applicable methods: find_data, set_data, delete_data
FlowExporterMapTable
Description: Configure a flow exporter map
Parent objects:
NetFlow
Child objects:
FlowExporterMap - Exporter map name
Applicable methods: get_keys, set_data, delete_data
FlowExporterMap
Description: Exporter map name
Parent objects:
FlowExporterMapTable
Keys:
ExporterMapName (mandatory)
Type: NFMapNameType
Description: Exporter map name
Child objects:
DSCP - Specify DSCP value for export packets
Destination - Configure export destination (collector)
Enable - Enable the flow exporter map
SourceInterface - Configure source interface for collector
UDP - Use UDP as transport protocol
VersionTable - Specify export version parameters
Applicable methods: find_data, set_data, delete_data
Enable
Description: Enable the flow exporter map
Parent objects:
FlowExporterMap
Values:
Enable (mandatory)
Type: xsd:boolean
Description: True to enable the flow exporter map
Default value: none.
Applicable methods: get_data, set_data, delete_data
Destination
Description: Configure export destination (collector)
Parent objects:
FlowExporterMap
Values:
IPAddress
Type: IPV4Address
Description: Destination IPv4 address
VRFName
Type: xsd:string
Description: VRF name
Default value: none.
Applicable methods: get_data, set_data, delete_data
DSCP
Description: Specify DSCP value for export packets
Parent objects:
FlowExporterMap
Values:
DSCP (mandatory)
Type: Range. Value lies between 0 and 63
Description: DSCP value
Default value: none.
Applicable methods: get_data, set_data, delete_data
SourceInterface
Description: Configure source interface for collector
Parent objects:
FlowExporterMap
Values:
InterfaceName (mandatory)
Type: Interface
Description: Source interface name
Default value: none.
Applicable methods: get_data, set_data, delete_data
UDP
Description: Use UDP as transport protocol
Parent objects:
FlowExporterMap
Child objects:
DestinationPort - Configure Destination UDP port
Applicable methods: find_data, set_data, delete_data
DestinationPort
Description: Configure Destination UDP port
Parent objects:
UDP
Values:
PortNumber (mandatory)
Type: Range. Value lies between 1024 and 65535
Description: Port number
Default value: none.
Applicable methods: get_data, set_data, delete_data
VersionTable
Description: Specify export version parameters
Parent objects:
FlowExporterMap
Child objects:
Version - Configure export version options
Applicable methods: get_keys, set_data, delete_data
Version
Description: Configure export version options
Parent objects:
VersionTable
Keys:
VersionNumber (mandatory)
Type: NFExportVersionType
Description: Export version number
Child objects:
CommonTemplateTimeout - Specify custom timeout for the template
DataTemplateTimeout - Data template configuration options
Enable - Enable the export version
Options - Specify options for exporting templates
OptionsTemplateTimeout - Option template configuration options
Applicable methods: find_data, set_data, delete_data
Enable
Description: Enable the export version
Parent objects:
Version
Values:
Enable (mandatory)
Type: xsd:boolean
Description: True to enable the export version
Default value: none.
Applicable methods: get_data, set_data, delete_data
Options
Description: Specify options for exporting templates
Parent objects:
Version
Child objects:
InterfaceTableExportTimeout - Specify timeout for exporting interface table
SamplerTableExportTimeout - Specify timeout for exporting sampler table
Applicable methods: find_data, set_data, delete_data
InterfaceTableExportTimeout
Description: Specify timeout for exporting interface table
Parent objects:
Options
Values:
Timeout (mandatory)
Type: NFExportTimeoutType
Description: Timeout value in seconds
Default value: none.
Applicable methods: get_data, set_data, delete_data
SamplerTableExportTimeout
Description: Specify timeout for exporting sampler table
Parent objects:
Options
Values:
Timeout (mandatory)
Type: NFExportTimeoutType
Description: Timeout value in seconds
Default value: none.
Applicable methods: get_data, set_data, delete_data
CommonTemplateTimeout
Description: Specify custom timeout for the template
Parent objects:
Version
Values:
Timeout (mandatory)
Type: NFTemplateTimeoutType
Description: Timeout value in seconds
Default value:
Timeout => 1800
Applicable methods: get_data, set_data, delete_data
DataTemplateTimeout
Description: Data template configuration options
Parent objects:
Version
Values:
Timeout (mandatory)
Type: NFTemplateTimeoutType
Description: Timeout value in seconds
Default value:
Timeout => 1800
Applicable methods: get_data, set_data, delete_data
OptionsTemplateTimeout
Description: Option template configuration options
Parent objects:
Version
Values:
Timeout (mandatory)
Type: NFTemplateTimeoutType
Description: Timeout value in seconds
Default value:
Timeout => 1800
Applicable methods: get_data, set_data, delete_data
FlowMonitorMapTable
Description: Flow monitor map configuration
Parent objects:
NetFlow
Child objects:
FlowMonitorMap - Monitor map name
Applicable methods: get_keys, set_data, delete_data
FlowMonitorMap
Description: Monitor map name
Parent objects:
FlowMonitorMapTable
Keys:
MonitorMapName (mandatory)
Type: NFMapNameType
Description: Monitor map name
Child objects:
CacheActiveAgingTimeout - Specify the active flow cache aging timeout
CacheAgingMode - Specify the flow cache aging mode
CacheEntries - Specify the number of entries in the flow cache
CacheInactiveAgingTimeout - Specify the inactive flow cache aging timeout
CacheUpdateAgingTimeout - Specify the update flow cache aging timeout
Enable - Enable the flow monitor map
ExporterTable - Configure exporters to be used by the monitor-map
Record - Specify a flow record format
Applicable methods: find_data, set_data, delete_data
Enable
Description: Enable the flow monitor map
Parent objects:
FlowMonitorMap
Values:
Enable (mandatory)
Type: xsd:boolean
Description: True to enable the flow monitor map
Default value: none.
Applicable methods: get_data, set_data, delete_data
ExporterTable
Description: Configure exporters to be used by the monitor-map
Parent objects:
FlowMonitorMap
Child objects:
Exporter - Configure exporter to be used by the monitor-map
Applicable methods: get_keys, get_entries, set_data, delete_data
Exporter
Description: Configure exporter to be used by the monitor-map
Parent objects:
ExporterTable
Keys:
ExporterName (mandatory)
Type: NFMapNameType
Description: Exporter name
Values:
Enable (mandatory)
Type: xsd:boolean
Description: True to enable the exporter
Default value: none.
Applicable methods: get_data, set_data, delete_data
CacheEntries
Description: Specify the number of entries in the flow cache
Parent objects:
FlowMonitorMap
Values:
Entries (mandatory)
Type: NFCacheEntryType
Description: Number of flow cache entries
Default value:
Entries => 65535
Applicable methods: get_data, set_data, delete_data
CacheActiveAgingTimeout
Description: Specify the active flow cache aging timeout
Parent objects:
FlowMonitorMap
Values:
Timeout (mandatory)
Type: NFActiveCacheAgingTimeoutType
Description: Timeout value in seconds
Default value:
Timeout => 1800
Applicable methods: get_data, set_data, delete_data
CacheInactiveAgingTimeout
Description: Specify the inactive flow cache aging timeout
Parent objects:
FlowMonitorMap
Values:
Timeout (mandatory)
Type: NFInactiveCacheAgingTimeoutType
Description: Timeout value in seconds
Default value:
Timeout => 15
Applicable methods: get_data, set_data, delete_data
CacheUpdateAgingTimeout
Description: Specify the update flow cache aging timeout
Parent objects:
FlowMonitorMap
Values:
Timeout (mandatory)
Type: NFUpdateCacheAgingTimeoutType
Description: Timeout value in seconds
Default value:
Timeout => 1800
Applicable methods: get_data, set_data, delete_data
CacheAgingMode
Description: Specify the flow cache aging mode
Parent objects:
FlowMonitorMap
Values:
Mode (mandatory)
Type: NFCacheAgingModeType
Description: Cache aging mode
Default value:
Mode => Normal
Applicable methods: get_data, set_data, delete_data
Record
Description: Specify a flow record format
Parent objects:
FlowMonitorMap
Values:
Record (mandatory)
Type: NFMapNameType
Description: Flow record format (Either 'ipv4-raw', 'mpls', or 'ipv6')
Field
Type: NFMapNameType
Description: Field type 'ipv4-fields', 'ipv6-fields' or 'ipv4-ipv6-fields'
Label
Type: Range. Value lies between 1 and 6
Description: Enter label value for MPLS record type
Default value: none.
Applicable methods: get_data, set_data, delete_data
FlowSamplerMapTable
Description: Flow sampler map configuration
Parent objects:
NetFlow
Child objects:
FlowSamplerMap - Sampler map name
Applicable methods: get_keys, set_data, delete_data
FlowSamplerMap
Description: Sampler map name
Parent objects:
FlowSamplerMapTable
Keys:
SamplerMapName (mandatory)
Type: NFMapNameType
Description: Sampler map name
Child objects:
Enable - Enable the sampler map
SamplingModeTable - Configure packet sampling mode
Applicable methods: find_data, set_data, delete_data
Enable
Description: Enable the sampler map
Parent objects:
FlowSamplerMap
Values:
Enable (mandatory)
Type: xsd:boolean
Description: True to enable the sampler map
Default value: none.
Applicable methods: get_data, set_data, delete_data
SamplingModeTable
Description: Configure packet sampling mode
Parent objects:
FlowSamplerMap
Child objects:
SamplingMode - Configure sampling mode
Applicable methods: get_keys, get_entries, set_data, delete_data
SamplingMode
Description: Configure sampling mode
Parent objects:
SamplingModeTable
Keys:
Mode (mandatory)
Type: NFSamplingModeType
Description: Sampling mode
Values:
SampleNumber (mandatory)
Type: NFSampleNumberType
Description: Number of packets to be sampled in the sampling interval
Interval (mandatory)
Type: NFSampleIntervalType
Description: Sampling interval in units of packets
Default value:
SampleNumber => 1
Interval => 10000
Applicable methods: get_data, set_data, delete_data
Datatypes
NFConfDummyType
Definition: xsd:boolean
NFSamplingModeType
Definition: Enumeration. Valid values are:
'Random' - Random sampling
NFTemplateTimeoutType
Definition: Range. Value lies between 1 and 604800
NFExportTimeoutType
Definition: Range. Value lies between 0 and 604800
NFMapNameType
Definition: BoundedString. Length less than or equal to 32
NFSampleNumberType
Definition: Range. Value lies between 1 and 1
NFSampleIntervalType
Definition: Range. Value lies between 1 and 65535
NFCacheEntryType
Definition: Range. Value lies between 4096 and 1000000
NFExportVersionType
Definition: Range. Value lies between 9 and 9
NFCacheAgingModeType
Definition: Enumeration. Valid values are:
'Normal' - Normal, caches age
'Permanent' - Permanent, caches never age
NFActiveCacheAgingTimeoutType
Definition: Range. Value lies between 1 and 604800
NFInactiveCacheAgingTimeoutType
Definition: Range. Value lies between 0 and 604800
NFUpdateCacheAgingTimeoutType
Definition: Range. Value lies between 1 and 604800
Perl Data Object Documentation for mlctrlr_cfg, version 1. 0.
Objects
MgmtMultilink
Description: Configure a multilink controller
Task IDs required: sonet-sdh
Parent objects:
InterfaceConfiguration
Child objects:
BundleTable - Configure a multilink bundle interface
Applicable methods: find_data, set_data, delete_data
BundleTable
Description: Configure a multilink bundle interface
Parent objects:
MgmtMultilink
Child objects:
Bundle - Bundle Id
Applicable methods: get_keys, get_entries, set_data, delete_data
Bundle
Description: Bundle Id
Parent objects:
BundleTable
Keys:
BundleId (mandatory)
Type: Range. Value lies between 1 and 1023
Description: Bundle Id
Values:
BundleId (mandatory)
Type: Range. Value lies between 1 and 1023
Description: Bundle Id
Default value: none.
Applicable methods: get_data, set_data, delete_data
Perl Data Object Documentation for ppp_mgr_cfg, version 3. 1.
Objects
PPP
Description: Interface PPP configuration data
Task IDs required: ppp
Parent objects:
InterfaceConfiguration
Child objects:
Authentication - PPP authentication parameters
CHAP - Challenge Handshake Authentication Protocol (CHAP) configuration data
FSM - PPP FSM configuration data
MS-CHAP - Microsoft Challenge Handshake Authentication Protocol (MS-CHAP) configuration data
Multilink - Multilink configuration
PAP - Password Authentication Protocol (PAP) configuration data
Applicable methods: find_data, set_data, delete_data
Perl Data Object Documentation for policymgr_oper, version 0. 0.
Objects
QOS
Description: QOS operational data
Task IDs required: qos
Parent objects:
Operational
Child objects:
NodeTable - Node-specific QOS operational data
Applicable methods: find_data
NodeTable
Description: Node-specific QOS operational data
Parent objects:
QOS
Child objects:
Node - QOS operational data for a particular node
Applicable methods: get_keys
Node
Description: QOS operational data for a particular node
Parent objects:
NodeTable
Keys:
NodeID (mandatory)
Type: NodeID
Description: The node
Child objects:
Policymap - Empty class
Applicable methods: find_data
Policymap
Description: Empty class
Parent objects:
Node
Child objects:
InterfaceTable - Container class for operational data of all interfaces
Applicable methods: find_data
InterfaceTable
Description: Container class for operational data of all interfaces
Parent objects:
Policymap
Child objects:
Interface - QOS policy-map operational data for a particular interface
Applicable methods: get_keys
Interface
Description: QOS policy-map operational data for a particular interface
Parent objects:
InterfaceTable
Keys:
Name (mandatory)
Type: Interface
Description: Name of the interface
Child objects:
Input - QOS policy-map operational data in the input direction
InputPostDecap - QOS policy-map operational data in the inbound post decryption direction (C12000 platform only)
InputPreDecap - QOS policy-map operational data in the inbound pre decryption direction (C12000 platform only)
Output - QOS policy-map operational data in the output direction
OutputPostEncap - QOS policy-map operational data in the outbound post encryption direction (C12000 platform only)
OutputPreEncap - QOS policy-map operational data in the outbound pre encryption direction (C12000 platform only)
Applicable methods: find_data
Input
Description: QOS policy-map operational data in the input direction
Parent objects:
Interface
Child objects:
Statistics - A piece of QOS policy-map operational data for an interface
Applicable methods: get_keys, get_entries
Statistics
Description: A piece of QOS policy-map operational data for an interface
Parent objects:
Input
Output
InputPreDecap
InputPostDecap
OutputPreEncap
OutputPostEncap
Keys:
Index (mandatory)
Type: xsd:unsignedInt
Description: Index of the table element
Value: policy_stats
Applicable methods: get_data
Output
Description: QOS policy-map operational data in the output direction
Parent objects:
Interface
Child objects:
Statistics - A piece of QOS policy-map operational data for an interface
Applicable methods: get_keys, get_entries
InputPreDecap
Description: QOS policy-map operational data in the inbound pre decryption direction (C12000 platform only)
Parent objects:
Interface
Child objects:
Statistics - A piece of QOS policy-map operational data for an interface
Applicable methods: get_keys, get_entries
InputPostDecap
Description: QOS policy-map operational data in the inbound post decryption direction (C12000 platform only)
Parent objects:
Interface
Child objects:
Statistics - A piece of QOS policy-map operational data for an interface
Applicable methods: get_keys, get_entries
OutputPreEncap
Description: QOS policy-map operational data in the outbound pre encryption direction (C12000 platform only)
Parent objects:
Interface
Child objects:
Statistics - A piece of QOS policy-map operational data for an interface
Applicable methods: get_keys, get_entries
OutputPostEncap
Description: QOS policy-map operational data in the outbound post encryption direction (C12000 platform only)
Parent objects:
Interface
Child objects:
Statistics - A piece of QOS policy-map operational data for an interface
Applicable methods: get_keys, get_entries
Perl Data Object Documentation for hfr_invmgr_common, version 0. 0.
Objects
SlotTable
Description: Slot table contains all slots in the rack
Parent objects:
Rack
Rack
Child objects:
Slot - Slot number
Applicable methods: can not be determined as the namespace is not known
Slot
Description: Slot number
Parent objects:
SlotTable
Keys:
Number (mandatory)
Type: xsd:unsignedInt
Description: Slot number
Child objects:
BasicAttributes - Attributes
CardTable - Card table contains all cards in the slot
Applicable methods: can not be determined as the namespace is not known
CardTable
Description: Card table contains all cards in the slot
Parent objects:
Slot
Child objects:
Card - Card number
Applicable methods: can not be determined as the namespace is not known
Card
Description: Card number
Parent objects:
CardTable
Keys:
Number (mandatory)
Type: xsd:unsignedInt
Description: card number
Child objects:
BasicAttributes - Attributes
HWComponentTable - HWComponent table contains all HW modules within the card
PortSlotTable - PortSlotTable contains all optics ports in a SPA/PLIM.
SensorTable - ModuleSensorTable contains all sensors in a Module.
SubSlotTable - SubSlotTable contains all subslots in a Slot
Applicable methods: can not be determined as the namespace is not known
SubSlotTable
Description: SubSlotTable contains all subslots in a Slot
Parent objects:
Card
Child objects:
SubSlot - SubSlot number
Applicable methods: can not be determined as the namespace is not known
SubSlot
Description: SubSlot number
Parent objects:
SubSlotTable
Keys:
Number (mandatory)
Type: xsd:unsignedInt
Description: subslot number
Child objects:
BasicAttributes - Attributes
Module - Module string
Applicable methods: can not be determined as the namespace is not known
Module
Description: Module string
Parent objects:
SubSlot
Child objects:
BasicAttributes - Attributes
PortSlotTable - PortSlotTable contains all optics ports in a SPA/PLIM.
SensorTable - ModuleSensorTable contains all sensors in a Module.
Applicable methods: can not be determined as the namespace is not known
PortSlotTable
Description: PortSlotTable contains all optics ports in a SPA/PLIM.
Parent objects:
Module
Card
Child objects:
PortSlot - PortSlot number in the SPA/PLIM
Applicable methods: can not be determined as the namespace is not known
PortSlot
Description: PortSlot number in the SPA/PLIM
Parent objects:
PortSlotTable
Keys:
Number (mandatory)
Type: xsd:unsignedInt
Description: portslot number
Child objects:
BasicAttributes - Attributes
Port - Port string
Applicable methods: can not be determined as the namespace is not known
Port
Description: Port string
Parent objects:
PortSlot
Child objects:
BasicAttributes - Attributes
Applicable methods: can not be determined as the namespace is not known
BasicAttributes
Description: Attributes
Parent objects:
Slot
Card
SubSlot
Module
PortSlot
Port
HWComponent
Sensor
Child objects:
BasicInfo - Inventory information
FRUInfo - Field Replaceable Unit (FRU) inventory information
Applicable methods: can not be determined as the namespace is not known
BasicInfo
Description: Inventory information
Parent objects:
BasicAttributes
Value: inv_phy_entity_basic_info
Applicable methods: can not be determined as the namespace is not known
FRUInfo
Description: Field Replaceable Unit (FRU) inventory information
Parent objects:
BasicAttributes
Value: inv_card_fru_info
Applicable methods: can not be determined as the namespace is not known
SensorTable
Description: ModuleSensorTable contains all sensors in a Module.
Parent objects:
Card
HWComponent
Module
Child objects:
Sensor - Sensor number in the Module
Applicable methods: can not be determined as the namespace is not known
Sensor
Description: Sensor number in the Module
Parent objects:
SensorTable
Keys:
Number (mandatory)
Type: xsd:unsignedInt
Description: sensor number
Child objects:
BasicAttributes - Attributes
Applicable methods: can not be determined as the namespace is not known
HWComponentTable
Description: HWComponent table contains all HW modules within the card
Parent objects:
Card
Child objects:
HWComponent - HWComponent number
Applicable methods: can not be determined as the namespace is not known
HWComponent
Description: HWComponent number
Parent objects:
HWComponentTable
Keys:
Number (mandatory)
Type: xsd:unsignedInt
Description: node number
Child objects:
BasicAttributes - Attributes
SensorTable - ModuleSensorTable contains all sensors in a Module.
Applicable methods: can not be determined as the namespace is not known
Perl Data Object Documentation for mpls_lcac_interface_cfg, version 12. 3.
Objects
LCAC
Description: LCAC specific MPLS interface configuration
Parent objects:
Interface
Child objects:
AdminWeight - Set administrative weight for the interface
AttributeFlags - Set user defined interface attribute flags
AttributeNames - Set the interface attribute names
BFD - Enable use of Bidirectional Forwarding Detection
DownThresholds - Set thresholds for decreased resource availability in %
Enable - Enable MPLS-TE on the link
SRLGTable - Configure SRLG membership for the interface
UpThresholds - Set thresholds for increased resource availability in %
Applicable methods: find_data, set_data, delete_data
AdminWeight
Description: Set administrative weight for the interface
Parent objects:
LCAC
Values:
Value (mandatory)
Type: xsd:unsignedInt
Description: Administrative weight for the interface
Default value: none.
Applicable methods: get_data, set_data, delete_data
AttributeFlags
Description: Set user defined interface attribute flags
Parent objects:
LCAC
Values:
Value (mandatory)
Type: HexInteger
Description: User defined interface attribute flags
Default value: none.
Applicable methods: get_data, set_data, delete_data
AttributeNames
Description: Set the interface attribute names
Parent objects:
LCAC
Values:
Values (mandatory)
Type: xsd:string[32]
Description: Array of Attribute Names
Default value: none.
Applicable methods: get_data, set_data, delete_data
DownThresholds
Description: Set thresholds for decreased resource availability in %
Parent objects:
LCAC
Values:
Values (mandatory)
Type: MPLS_LCACFloodingThresholdPercentRange[14]
Description: Array of down threshold percentage
Default value: none.
Applicable methods: get_data, set_data, delete_data
UpThresholds
Description: Set thresholds for increased resource availability in %
Parent objects:
LCAC
Values:
Values (mandatory)
Type: MPLS_LCACFloodingThresholdPercentRange[14]
Description: Array of up threshold percentage
Default value: none.
Applicable methods: get_data, set_data, delete_data
Enable
Description: Enable MPLS-TE on the link
Parent objects:
LCAC
Values:
Enable (mandatory)
Type: xsd:boolean
Description: Enable MPLS-TE on the link
Default value: none.
Applicable methods: get_data, set_data, delete_data
BFD
Description: Enable use of Bidirectional Forwarding Detection
Parent objects:
LCAC
Values:
Enable (mandatory)
Type: xsd:boolean
Description: Enable BFD
Default value: none.
Applicable methods: get_data, set_data, delete_data
SRLGTable
Description: Configure SRLG membership for the interface
Parent objects:
LCAC
Child objects:
SRLG - SRLG membership number
Applicable methods: get_keys, get_entries, set_data, delete_data
SRLG
Description: SRLG membership number
Parent objects:
SRLGTable
Keys:
SRLGNumber (mandatory)
Type: Range. Value lies between 0 and -1
Description: SRLG membership number
Values:
Enable (mandatory)
Type: xsd:boolean
Description: Always set to true
Default value: none.
Applicable methods: get_data, set_data, delete_data
Datatypes
MPLS_LCACFloodingThresholdPercentRange
Definition: Range. Value lies between 0 and 100
Perl Data Object Documentation for ipv4_msdp_oper, version 3. 1.
Objects
MSDP
Description: MSDP operational data
Task IDs required: multicast
Parent objects:
Operational
Child objects:
AllSACacheTable - All of MSDP SA Cache ignoring source flags
Globals - MSDP Global Data
PeerSummaryTable - MSDP Peers summary
PeerTable - MSDP Peers
RPFTable - MSDP Reverse Path Forwaring Info
SACacheTable - MSDP SA Cache table - sources with Local & External flags Set
StatPeerTable - Statistics for MSDP Peers
Applicable methods: find_data
Globals
Description: MSDP Global Data
Parent objects:
MSDP
Value: msdp_global_bag
Applicable methods: get_data
AllSACacheTable
Description: All of MSDP SA Cache ignoring source flags
Parent objects:
MSDP
Child objects:
AllSACache - MSDP All SA Cache Entries ignoring source flags
Applicable methods: get_keys, get_entries
AllSACache
Description: MSDP All SA Cache Entries ignoring source flags
Parent objects:
AllSACacheTable
Keys:
SourceAddress
Type: IPV4Address
Description: Source Address
GroupAddress
Type: IPV4Address
Description: Group Address
Value: msdp_src_bag
Applicable methods: get_data
SACacheTable
Description: MSDP SA Cache table - sources with Local & External flags Set
Parent objects:
MSDP
Child objects:
SACache - MSDP SA Cache Entry - Sources with Local & External flags set
Applicable filters:
MSDPPeerFilter
MSDP_SGFilter
MSDP_RPFilter
MSDP_ASNFilter
Applicable methods: get_keys, get_entries
SACache
Description: MSDP SA Cache Entry - Sources with Local & External flags set
Parent objects:
SACacheTable
Keys:
SourceAddress
Type: IPV4Address
Description: Source Address
GroupAddress
Type: IPV4Address
Description: Group Address
RPAddress
Type: IPV4Address
Description: RP Address
ASNumber
Type: Range. Value lies between 1 and 65535
Description: AS Number
Value: msdp_src_bag
Applicable methods: get_data
PeerTable
Description: MSDP Peers
Parent objects:
MSDP
Child objects:
Peer - MSDP Peer Info
Applicable methods: get_keys, get_entries
Peer
Description: MSDP Peer Info
Parent objects:
PeerTable
Keys:
PeerAddress (mandatory)
Type: IPV4Address
Description: Peer Address
Value: msdp_peer_bag
Applicable methods: get_data
PeerSummaryTable
Description: MSDP Peers summary
Parent objects:
MSDP
Child objects:
PeerSummary - MSDP Peer Summary Info
Applicable methods: get_keys, get_entries
PeerSummary
Description: MSDP Peer Summary Info
Parent objects:
PeerSummaryTable
Keys:
PeerAddress (mandatory)
Type: IPV4Address
Description: Peer Address
Value: msdp_peer_summ_bag
Applicable methods: get_data
RPFTable
Description: MSDP Reverse Path Forwaring Info
Parent objects:
MSDP
Child objects:
RPF - MSDP Reverse Path Forwaring entries
Applicable methods: get_keys, get_entries
RPF
Description: MSDP Reverse Path Forwaring entries
Parent objects:
RPFTable
Keys:
RPAddress (mandatory)
Type: IPV4Address
Description: RP Address
Value: msdp_rpf_bag
Applicable methods: get_data
StatPeerTable
Description: Statistics for MSDP Peers
Parent objects:
MSDP
Child objects:
StatPeer - MSDP Peer Statistics Info
Applicable methods: get_keys, get_entries
StatPeer
Description: MSDP Peer Statistics Info
Parent objects:
StatPeerTable
Keys:
PeerAddress (mandatory)
Type: IPV4Address
Description: Peer Address
Value: msdp_stats_peer_bag
Applicable methods: get_data
Filters
MSDP_SGFilter
Description: <Filter based on Source & Group Address>
Parameters:
SourceAddress
Type: IPV4Address
Description: Source Address
GroupAddress
Type: IPV4Address
Description: Group Address
MSDP_RPFilter
Description: <Filter based on RP Address>
Parameters:
RPAddress (mandatory)
Type: IPV4Address
Description: RP Address
MSDPPeerFilter
Description: <Filter based on advertising Peer Address>
Parameters:
PeerAddress (mandatory)
Type: IPV4Address
Description: Peer Address
MSDP_ASNFilter
Description: <Filter based on AS Number>
Parameters:
ASNumber (mandatory)
Type: Range. Value lies between 1 and 65535
Description: AS Number
Perl Data Object Documentation for ipsla_op_def_icmp_echo_cfg, version 7. 2.
Objects
ICMPEcho
Description: ICMPEcho Operation type
Parent objects:
OperationType
Child objects:
Create - Create operation with specified type
DataSize - Protocol data size in payload of probe packets
DestAddress - IPv4 address of the target device
EnhancedStatsTable - Table of statistics collection intervals
Frequency - Frequency of the probing
History - Configure the history parameters for this operation
SourceAddress - IPv4 address of the source device
Statistics - Statistics collection aggregated over an hour
Tag - Add a tag for this operation
Timeout - Probe/Control timeout interval
Tos - Type of service setting in probe packet
VRF - Configure IPSLA for a VPN Routing/Forwarding instance)
Applicable methods: find_data, set_data, delete_data
DataSize
Description: Protocol data size in payload of probe packets
Parent objects:
ICMPEcho
Child objects:
Request - Payload size in request probe packet
Applicable methods: find_data, set_data, delete_data
Request
Description: Payload size in request probe packet
Parent objects:
DataSize
Values:
RequestDataSize (mandatory)
Type: Range. Value lies between 0 and 16384
Description: Request data size in bytes
Default value:
RequestDataSize => 36
Applicable methods: get_data, set_data, delete_data
Perl Data Object Documentation for crypto_ipsec_imp_oper, version 1. 5.
Objects
IPSecStaticSessionInfo
Description: IPSec operational data
Task IDs required: crypto
Parent objects:
Operational
Child objects:
CryptoProfileTable - IPSec Profile table
FVRFTable - SAs by FVRF
IVRFTable - SAs by IVRF
InterfaceTable - IPSec Interface table
NodeTable - SAs by Node ID (location)
PeerTable - SAs by Peer
ProfileTable - IPSec Manager Profile table
SecurityAssociationBrief - IPSec summary
SecurityAssociationCount - IPSec SA Count
SecurityAssociationTable - IPSec SA
TransformTable - IPSec Transform table
Applicable methods: find_data
ProfileTable
Description: IPSec Manager Profile table
Parent objects:
IPSecStaticSessionInfo
Child objects:
Profile - IPSec profile name - maximum 32 characters
Applicable methods: get_keys, get_entries
Profile
Description: IPSec profile name - maximum 32 characters
Parent objects:
ProfileTable
Keys:
Profile (mandatory)
Type: CryptoNameString
Description: IPSec profile name
Value: show_sa_details__
Applicable methods: get_data
SecurityAssociationTable
Description: IPSec SA
Parent objects:
IPSecStaticSessionInfo
Child objects:
SecurityAssociation - An IPSec SA Entry
Applicable methods: get_keys, get_entries
SecurityAssociation
Description: An IPSec SA Entry
Parent objects:
SecurityAssociationTable
Keys:
ID (mandatory)
Type: xsd:unsignedInt
Description: SA ID
Value: show_sa_details__
Applicable methods: get_data
SecurityAssociationCount
Description: IPSec SA Count
Parent objects:
IPSecStaticSessionInfo
Child objects:
SACountNodeTable - IPSec SA Count Node
SecurityAssociationCountAll - IPSec SA Count All
Applicable methods: find_data
SecurityAssociationCountAll
Description: IPSec SA Count All
Parent objects:
SecurityAssociationCount
Value: show_sa_count__
Applicable methods: get_data
SACountNodeTable
Description: IPSec SA Count Node
Parent objects:
SecurityAssociationCount
Child objects:
SACountNode - IPSec SA Count Node Entry
Applicable methods: get_keys, get_entries
SACountNode
Description: IPSec SA Count Node Entry
Parent objects:
SACountNodeTable
Keys:
Node (mandatory)
Type: NodeID
Description: Node
Value: show_sa_count__
Applicable methods: get_data
SecurityAssociationBrief
Description: IPSec summary
Parent objects:
IPSecStaticSessionInfo
Value: show_sa_brief_details__
Applicable methods: get_data
PeerTable
Description: SAs by Peer
Parent objects:
IPSecStaticSessionInfo
Child objects:
Peer - An IPSec Peer Entry
Applicable methods: get_keys
Peer
Description: An IPSec Peer Entry
Parent objects:
PeerTable
Keys:
Address (mandatory)
Type: IPV4Address
Description: Peer IPv4 address
Child objects:
PeerFVRFTable - Table of SAs per Peer by FVRF
PeerPortTable - Table of SAs per Peer by Port
PeerSAList - SAs per Peer Entry
Applicable methods: find_data
PeerSAList
Description: SAs per Peer Entry
Parent objects:
Peer
Value: show_sa_details__
Applicable methods: get_data
PeerFVRFTable
Description: Table of SAs per Peer by FVRF
Parent objects:
Peer
Child objects:
PeerFVRFEntry - SAs per Peer per FVRF
Applicable methods: get_keys, get_entries
PeerFVRFEntry
Description: SAs per Peer per FVRF
Parent objects:
PeerFVRFTable
Keys:
FVRF (mandatory)
Type: CryptoNameString
Description: FVRF
Value: show_sa_details__
Applicable methods: get_data
PeerPortTable
Description: Table of SAs per Peer by Port
Parent objects:
Peer
Child objects:
PeerPortEntry - SAs per Peer per Port
Applicable methods: get_keys, get_entries
PeerPortEntry
Description: SAs per Peer per Port
Parent objects:
PeerPortTable
Keys:
ID (mandatory)
Type: xsd:unsignedInt
Description: Port
Value: show_sa_details__
Applicable methods: get_data
NodeTable
Description: SAs by Node ID (location)
Parent objects:
IPSecStaticSessionInfo
Child objects:
Node - An IPSec Node Entry
Applicable methods: get_keys, get_entries
Node
Description: An IPSec Node Entry
Parent objects:
NodeTable
Keys:
Node (mandatory)
Type: NodeID
Description: Node
Value: show_sa_details__
Applicable methods: get_data
IVRFTable
Description: SAs by IVRF
Parent objects:
IPSecStaticSessionInfo
Child objects:
IVRF - An IPSec IVRF Entry
Applicable methods: get_keys, get_entries
IVRF
Description: An IPSec IVRF Entry
Parent objects:
IVRFTable
Keys:
IVRF (mandatory)
Type: CryptoNameString
Description: IVRF
Value: show_sa_details__
Applicable methods: get_data
FVRFTable
Description: SAs by FVRF
Parent objects:
IPSecStaticSessionInfo
Child objects:
FVRF - An IPSec FVRF Entry
Applicable methods: get_keys, get_entries
FVRF
Description: An IPSec FVRF Entry
Parent objects:
FVRFTable
Keys:
FVRF (mandatory)
Type: CryptoNameString
Description: FVRF
Value: show_sa_details__
Applicable methods: get_data
InterfaceTable
Description: IPSec Interface table
Parent objects:
IPSecStaticSessionInfo
Child objects:
Interface - IPSec interface name
Applicable methods: get_keys, get_entries
Interface
Description: IPSec interface name
Parent objects:
InterfaceTable
Keys:
Interface (mandatory)
Type: Interface
Description: IPSec interface name
Value: show_ipsec_intf_details__
Applicable methods: get_data
CryptoProfileTable
Description: IPSec Profile table
Parent objects:
IPSecStaticSessionInfo
Child objects:
CryptoProfile - IPSec crypto profile name
Applicable methods: get_keys, get_entries
CryptoProfile
Description: IPSec crypto profile name
Parent objects:
CryptoProfileTable
Keys:
Profile (mandatory)
Type: CryptoNameString
Description: IPSec profile name
Value: show_ipsec_profiles__
Applicable methods: get_data
TransformTable
Description: IPSec Transform table
Parent objects:
IPSecStaticSessionInfo
Child objects:
TransformSet - IPSec Transform-Set name
Applicable methods: get_keys, get_entries
TransformSet
Description: IPSec Transform-Set name
Parent objects:
TransformTable
Keys:
TransformSet (mandatory)
Type: CryptoNameString
Description: IPSec Transform-Set name
Value: show_ipsec_ts__
Applicable methods: get_data
Perl Data Object Documentation for ipsla_mplslm_def_cfg, version 7. 2.
Objects
DefinitionTable
Description: MPLS LSP Monitor definition table
Parent objects:
MPLS_LSPMonitor
Child objects:
Definition - MPLS LSP Monitor definition
Applicable methods: get_keys, set_data, delete_data
Definition
Description: MPLS LSP Monitor definition
Parent objects:
DefinitionTable
Keys:
MonitorID (mandatory)
Type: Range. Value lies between 1 and 2048
Description: Monitor identifier
Child objects:
OperationType - Operation type specification
Applicable methods: find_data, set_data, delete_data
OperationType
Description: Operation type specification
Parent objects:
Definition
Child objects:
MPLS_LSPPing - Perform MPLS LSP Ping operation
MPLS_LSPTrace - Perform MPLS LSP Trace operation
Applicable methods: find_data, set_data, delete_data
MPLS_LSPPing
Description: Perform MPLS LSP Ping operation
Parent objects:
OperationType
Child objects:
Accesslist - Apply access list to filter PE addresses
Create - Create MPLSLM instance with specified type
DataSize - Protocol data size in payload of probe packets
EXPBits - EXP in MPLS LSP echo request header
ForceExplicitNull - Forced option for the MPLS LSP operation
LSPSelector - Attributes used for path selection during LSP load balancing
OutputInterface - Echo request output interface
OutputNexthop - Echo request output nexthop
PathDiscover - Path discover configuration
Reply - Echo reply options for the MPLS LSP operation
Scan - Scanning parameters configuration
Statistics - Statistics collection aggregated over an hour
TTL - Time to live
Tag - Add a tag for this MPLSLM instance
Timeout - Probe/Control timeout interval
VRF - Specify a VRF instance to be monitored
Applicable methods: find_data, set_data, delete_data
Create
Description: Create MPLSLM instance with specified type
Parent objects:
MPLS_LSPPing
MPLS_LSPTrace
Values:
Create (mandatory)
Type: xsd:boolean
Description: Create MPLSLM instance with specified type
Default value: none.
Applicable methods: get_data, set_data, delete_data
VRF
Description: Specify a VRF instance to be monitored
Parent objects:
MPLS_LSPPing
MPLS_LSPTrace
Values:
VRFName (mandatory)
Type: BoundedString. Length less than or equal to 32
Description: VRF instance name
Default value: none.
Applicable methods: get_data, set_data, delete_data
Accesslist
Description: Apply access list to filter PE addresses
Parent objects:
MPLS_LSPPing
MPLS_LSPTrace
Values:
ACLName (mandatory)
Type: BoundedString. Length less than or equal to 32
Description: Access list name
Default value: none.
Applicable methods: get_data, set_data, delete_data
Scan
Description: Scanning parameters configuration
Parent objects:
MPLS_LSPPing
MPLS_LSPTrace
Child objects:
DeleteFactor - Number of times for automatic deletion
Interval - Time interval for automatic discovery
Applicable methods: find_data, set_data, delete_data
Interval
Description: Time interval for automatic discovery
Parent objects:
Scan
Values:
IntervalValue (mandatory)
Type: Range. Value lies between 1 and 70560
Description: Scan interval in minutes
Default value:
IntervalValue => 240
Applicable methods: get_data, set_data, delete_data
DeleteFactor
Description: Number of times for automatic deletion
Parent objects:
Scan
Values:
FactorValue (mandatory)
Type: Range. Value lies between 0 and 2147483647
Description: Scan delete factor value
Default value:
FactorValue => 1
Applicable methods: get_data, set_data, delete_data
DataSize
Description: Protocol data size in payload of probe packets
Parent objects:
MPLS_LSPPing
Child objects:
Request - Payload size in request probe packet
Applicable methods: find_data, set_data, delete_data
Request
Description: Payload size in request probe packet
Parent objects:
DataSize
Values:
RequestDataSize (mandatory)
Type: Range. Value lies between 100 and 17986
Description: Request data size in bytes
Default value:
RequestDataSize => 100
Applicable methods: get_data, set_data, delete_data
Tag
Description: Add a tag for this MPLSLM instance
Parent objects:
MPLS_LSPPing
MPLS_LSPTrace
Values:
Tag (mandatory)
Type: BoundedString. Length less than or equal to 100
Description: Tag string
Default value: none.
Applicable methods: get_data, set_data, delete_data
Timeout
Description: Probe/Control timeout interval
Parent objects:
MPLS_LSPPing
MPLS_LSPTrace
Values:
TimeoutValue (mandatory)
Type: Range. Value lies between 1 and 604800000
Description: Probe/Control timeout in milliseconds
Default value:
TimeoutValue => 5000
Applicable methods: get_data, set_data, delete_data
LSPSelector
Description: Attributes used for path selection during LSP load balancing
Parent objects:
MPLS_LSPPing
MPLS_LSPTrace
Values:
Address (mandatory)
Type: IPV4Address
Description: Local host address to use in the echo request
Default value:
Address => 2130706433
Applicable methods: get_data, set_data, delete_data
ForceExplicitNull
Description: Forced option for the MPLS LSP operation
Parent objects:
MPLS_LSPPing
MPLS_LSPTrace
Values:
Enable (mandatory)
Type: xsd:boolean
Description: Add Explicit Null label to the stack
Default value: none.
Applicable methods: get_data, set_data, delete_data
Reply
Description: Echo reply options for the MPLS LSP operation
Parent objects:
MPLS_LSPPing
MPLS_LSPTrace
Child objects:
DSCPBits - DSCP bits in the reply IP header
Mode - Configures reply mode parameters
Applicable methods: find_data, set_data, delete_data
DSCPBits
Description: DSCP bits in the reply IP header
Parent objects:
Reply
Values:
DSCPBitsValue (mandatory)
Type: IPSLA_LSPReplyDSCP
Description: DSCP bits value
Default value: none.
Applicable methods: get_data, set_data, delete_data
Mode
Description: Configures reply mode parameters
Parent objects:
Reply
Values:
ModeValue (mandatory)
Type: IPSLA_LSPMonitorReplyMode
Description: Enables use of router alert in echo reply packets
Default value: none.
Applicable methods: get_data, set_data, delete_data
TTL
Description: Time to live
Parent objects:
MPLS_LSPPing
Values:
TTLValue (mandatory)
Type: Range. Value lies between 1 and 255
Description: Time to live value
Default value:
TTLValue => 255
Applicable methods: get_data, set_data, delete_data
EXPBits
Description: EXP in MPLS LSP echo request header
Parent objects:
MPLS_LSPPing
MPLS_LSPTrace
Values:
EXPBitValue (mandatory)
Type: Range. Value lies between 0 and 7
Description: EXP bits in MPLS LSP echo request header
Default value:
EXPBitValue => 0
Applicable methods: get_data, set_data, delete_data
OutputInterface
Description: Echo request output interface
Parent objects:
MPLS_LSPPing
MPLS_LSPTrace
Values:
Interface (mandatory)
Type: Interface
Description: Specify the interface
Default value: none.
Applicable methods: get_data, set_data, delete_data
OutputNexthop
Description: Echo request output nexthop
Parent objects:
MPLS_LSPPing
MPLS_LSPTrace
Values:
Nexthop (mandatory)
Type: IPV4Address
Description: Specify the nexthop
Default value: none.
Applicable methods: get_data, set_data, delete_data
Statistics
Description: Statistics collection aggregated over an hour
Parent objects:
MPLS_LSPPing
MPLS_LSPTrace
Child objects:
Hours - Number of hours for which hourly statistics are kept
Applicable methods: find_data, set_data, delete_data
Hours
Description: Number of hours for which hourly statistics are kept
Parent objects:
Statistics
Values:
HoursCount (mandatory)
Type: Range. Value lies between 0 and 2
Description: Specify number of hours
Default value:
HoursCount => 2
Applicable methods: get_data, set_data, delete_data
PathDiscover
Description: Path discover configuration
Parent objects:
MPLS_LSPPing
Child objects:
Create - Create LPD instance
Echo - Echo parameters configuration
Path - Path parameters configuration
ScanPeriod - Time period for finishing path discovery
Session - Session parameters configuration
Applicable methods: find_data, set_data, delete_data
Create
Description: Create LPD instance
Parent objects:
PathDiscover
Values:
Create (mandatory)
Type: xsd:boolean
Description: Create LPD instance
Default value: none.
Applicable methods: get_data, set_data, delete_data
Session
Description: Session parameters configuration
Parent objects:
PathDiscover
Child objects:
Limit - Number of concurrent active path discovery requests at one time
Timeout - Timeout value for path discovery request
Applicable methods: find_data, set_data, delete_data
Limit
Description: Number of concurrent active path discovery requests at one time
Parent objects:
Session
Values:
SessionCount (mandatory)
Type: Range. Value lies between 1 and 15
Description: Number of requests
Default value:
SessionCount => 1
Applicable methods: get_data, set_data, delete_data
Timeout
Description: Timeout value for path discovery request
Parent objects:
Session
Values:
TimeoutValue (mandatory)
Type: Range. Value lies between 1 and 900
Description: Timeout value in seconds
Default value:
TimeoutValue => 120
Applicable methods: get_data, set_data, delete_data
ScanPeriod
Description: Time period for finishing path discovery
Parent objects:
PathDiscover
Values:
PeriodValue (mandatory)
Type: Range. Value lies between 0 and 7200
Description: Time period value in minutes
Default value:
PeriodValue => 5
Applicable methods: get_data, set_data, delete_data
Path
Description: Path parameters configuration
Parent objects:
PathDiscover
Child objects:
Retry - Number of attempts before declaring the path as down
SecondaryFrequency - Frequency to be used if path failure condition is detected
Applicable methods: find_data, set_data, delete_data
Retry
Description: Number of attempts before declaring the path as down
Parent objects:
Path
Values:
RetryCount (mandatory)
Type: Range. Value lies between 1 and 16
Description: Retry count
Default value:
RetryCount => 1
Applicable methods: get_data, set_data, delete_data
SecondaryFrequency
Description: Frequency to be used if path failure condition is detected
Parent objects:
Path
Values:
Type (mandatory)
Type: IPSLASecondaryFrequencyType
Description: Condition type of path failure
Frequency (mandatory)
Type: Range. Value lies between 1 and 604800
Description: Frequency value in seconds
Default value: none.
Applicable methods: get_data, set_data, delete_data
Echo
Description: Echo parameters configuration
Parent objects:
PathDiscover
Child objects:
Interval - Send interval between echo requests during path discovery
MaximumLSPSelector - Maximum IPv4 address used as destination in echo request
Multipath - Downstream map multipath settings
Retry - Number of timeout retry attempts during path discovery
Timeout - Timeout value for echo requests during path discovery
Applicable methods: find_data, set_data, delete_data
Interval
Description: Send interval between echo requests during path discovery
Parent objects:
Echo
Values:
IntervalValue (mandatory)
Type: Range. Value lies between 0 and 3600000
Description: Interval time in milliseconds
Default value:
IntervalValue => 0
Applicable methods: get_data, set_data, delete_data
Timeout
Description: Timeout value for echo requests during path discovery
Parent objects:
Echo
Values:
TimeoutValue (mandatory)
Type: Range. Value lies between 1 and 3600
Description: Timeout value in seconds
Default value:
TimeoutValue => 5
Applicable methods: get_data, set_data, delete_data
Retry
Description: Number of timeout retry attempts during path discovery
Parent objects:
Echo
Values:
RetryCount (mandatory)
Type: Range. Value lies between 0 and 10
Description: Retry count
Default value:
RetryCount => 3
Applicable methods: get_data, set_data, delete_data
Multipath
Description: Downstream map multipath settings
Parent objects:
Echo
Child objects:
BitmapSize - Multipath bit size
Applicable methods: find_data, set_data, delete_data
BitmapSize
Description: Multipath bit size
Parent objects:
Multipath
Values:
BitmapSizeValue (mandatory)
Type: Range. Value lies between 1 and 256
Description: Bitmap size
Default value:
BitmapSizeValue => 32
Applicable methods: get_data, set_data, delete_data
MaximumLSPSelector
Description: Maximum IPv4 address used as destination in echo request
Parent objects:
Echo
Values:
Address (mandatory)
Type: IPV4Address
Description: Local host address to use as maximum value
Default value:
Address => 2147483647
Applicable methods: get_data, set_data, delete_data
MPLS_LSPTrace
Description: Perform MPLS LSP Trace operation
Parent objects:
OperationType
Child objects:
Accesslist - Apply access list to filter PE addresses
Create - Create MPLSLM instance with specified type
EXPBits - EXP in MPLS LSP echo request header
ForceExplicitNull - Forced option for the MPLS LSP operation
LSPSelector - Attributes used for path selection during LSP load balancing
OutputInterface - Echo request output interface
OutputNexthop - Echo request output nexthop
Reply - Echo reply options for the MPLS LSP operation
Scan - Scanning parameters configuration
Statistics - Statistics collection aggregated over an hour
TTL - Time to live
Tag - Add a tag for this MPLSLM instance
Timeout - Probe/Control timeout interval
VRF - Specify a VRF instance to be monitored
Applicable methods: find_data, set_data, delete_data
TTL
Description: Time to live
Parent objects:
MPLS_LSPTrace
Values:
TTLValue (mandatory)
Type: Range. Value lies between 1 and 255
Description: Time to live value
Default value:
TTLValue => 30
Applicable methods: get_data, set_data, delete_data
Datatypes
IPSLA_LSPMonitorReplyMode
Definition: Enumeration. Valid values are:
'IPV4_UDPRouterAlert' - Send replies via IPv4 UDP packets with Router Alert option
IPSLASecondaryFrequencyType
Definition: Enumeration. Valid values are:
'ConnectionLoss' - Enable secondary frequency for connection loss
'Timeout' - Enable secondary frequency for timeout
'Both' - Enable secondary frequency for timeout and connection loss
Perl Data Object Documentation for bundlemgr_lacp_mbr_action, version 1. 0.
Objects
LACPBundleMembers
Description: LACP action commands
Task IDs required: bundle
Parent objects:
Action
Child objects:
MemberTable - Table of LACP bundle member interfaces
Applicable methods: set_data
MemberTable
Description: Table of LACP bundle member interfaces
Parent objects:
LACPBundleMembers
Child objects:
Member - Member interface
Applicable methods: set_data
Member
Description: Member interface
Parent objects:
MemberTable
Keys:
MemberInterface (mandatory)
Type: Interface
Description: Member interface
Child objects:
ClearCounters - Clear LACP counters for a member interface
Applicable methods: set_data
ClearCounters
Description: Clear LACP counters for a member interface
Parent objects:
Member
Values:
ClearCounters (mandatory)
Type: xsd:boolean
Description: Clear the LACP counters
Default value: none.
Applicable methods: set_data
Perl Data Object Documentation for isis_action, version 5. 1.
Objects
ISIS
Description: IS-IS action data
Task IDs required: isis
Parent objects:
Action
Child objects:
InstanceTable - IS-IS instance action data
Applicable methods: set_data
InstanceTable
Description: IS-IS instance action data
Parent objects:
ISIS
Child objects:
Instance - Action data for a single IS-IS instance
Applicable methods: set_data
Instance
Description: Action data for a single IS-IS instance
Parent objects:
InstanceTable
Keys:
InstanceID (mandatory)
Type: ISISInstanceNameType
Description: Instance identifier
Child objects:
ClearAllInterfaceStatistics - Clear IS-IS statistics data
ClearAllRoutes - Clear IS-IS route data
ClearInterfaceStatisticsTable - Clear Interface statistics
ClearProcess - Clear all information from an IS-IS instance (soft reset)
ClearTopoRoutesTable - Clear IS-IS topology route data
Applicable methods: set_data
ClearProcess
Description: Clear all information from an IS-IS instance (soft reset)
Parent objects:
Instance
Values:
True (mandatory)
Type: xsd:boolean
Description: Value ignored
Default value: none.
Applicable methods: set_data
ClearAllInterfaceStatistics
Description: Clear IS-IS statistics data
Parent objects:
Instance
Child objects:
Trigger - Clear all statistics data from all interfaces.
Applicable methods: set_data
Trigger
Description: Clear all statistics data from all interfaces.
Parent objects:
ClearAllInterfaceStatistics
Values:
True (mandatory)
Type: xsd:boolean
Description: Value ignored
Default value: none.
Applicable methods: set_data
ClearInterfaceStatisticsTable
Description: Clear Interface statistics
Parent objects:
Instance
Child objects:
ClearInterfaceStatistics - Clear statistics data for one IS-IS interface
Applicable methods: set_data
ClearInterfaceStatistics
Description: Clear statistics data for one IS-IS interface
Parent objects:
ClearInterfaceStatisticsTable
Keys:
Interface (mandatory)
Type: Interface
Description: Interface name
Child objects:
Trigger - Clear all statistics data from an interface.
Applicable methods: set_data
Trigger
Description: Clear all statistics data from an interface.
Parent objects:
ClearInterfaceStatistics
Values:
True (mandatory)
Type: xsd:boolean
Description: Value ignored
Default value: none.
Applicable methods: set_data
ClearAllRoutes
Description: Clear IS-IS route data
Parent objects:
Instance
Child objects:
Trigger - Clear all routes from all toplogies.
Applicable methods: set_data
Trigger
Description: Clear all routes from all toplogies.
Parent objects:
ClearAllRoutes
Values:
True (mandatory)
Type: xsd:boolean
Description: Value ignored
Default value: none.
Applicable methods: set_data
ClearTopoRoutesTable
Description: Clear IS-IS topology route data
Parent objects:
Instance
Child objects:
ClearTopoRoutes - Clear routes relating to a single IS-IS topology
Applicable methods: set_data
ClearTopoRoutes
Description: Clear routes relating to a single IS-IS topology
Parent objects:
ClearTopoRoutesTable
Keys:
AF
Type: ISISAddressFamily
Description: Address-family
SubAF
Type: ISISSubAddressFamily
Description: Sub-address-family
TopoName
Type: ISISTopologyName
Description: Topology Name
Child objects:
IPV4Routes - IPv4 local route
IPV6Routes - IPv6 local route
Applicable methods: set_data
IPV4Routes
Description: IPv4 local route
Parent objects:
ClearTopoRoutes
Child objects:
Trigger - Clear all routes from IPv4 toplogy.
Applicable methods: set_data
Trigger
Description: Clear all routes from IPv4 toplogy.
Parent objects:
IPV4Routes
Values:
True (mandatory)
Type: xsd:boolean
Description: Value ignored
Default value: none.
Applicable methods: set_data
IPV6Routes
Description: IPv6 local route
Parent objects:
ClearTopoRoutes
Child objects:
Trigger - Clear all routes from IPv6 toplogy.
Applicable methods: set_data
Trigger
Description: Clear all routes from IPv6 toplogy.
Parent objects:
IPV6Routes
Values:
True (mandatory)
Type: xsd:boolean
Description: Value ignored
Default value: none.
Applicable methods: set_data
Perl Data Object Documentation for ip_ntp_oper, version 5. 0.
Objects
NTP
Description: NTP operational data
Task IDs required: ip-services
Parent objects:
Operational
Child objects:
NodeTable - Node-specific NTP operational data
Applicable methods: find_data
NodeTable
Description: Node-specific NTP operational data
Parent objects:
NTP
Child objects:
Node - NTP operational data for a particular node
Applicable methods: get_keys
Node
Description: NTP operational data for a particular node
Parent objects:
NodeTable
Keys:
Node (mandatory)
Type: NodeID
Description: The node identifier
Child objects:
Associations - NTP Associations information
AssociationsDetail - NTP Associations Detail information
Status - Status of NTP peer(s)
Applicable methods: find_data
Status
Description: Status of NTP peer(s)
Parent objects:
Node
Value: ntp_edm_status_result
Applicable methods: get_data
Associations
Description: NTP Associations information
Parent objects:
Node
Value: ntp_edm_assoc_summary_result
Applicable methods: get_data
AssociationsDetail
Description: NTP Associations Detail information
Parent objects:
Node
Value: ntp_edm_assoc_detail_result
Applicable methods: get_data
Perl Data Object Documentation for l2vpn_oper, version 6. 0.
Objects
L2VPN
Description: L2VPN operational data
Task IDs required: l2vpn
Parent objects:
Operational
Child objects:
BridgeACTable - Bridge Domain Attachment Circuit Table
BridgeAccessPWTable - Bridge Domain Access Pseudowire Table
BridgeDomainTable - Bridge Domain Table
BridgeHardwareTable - Bridge Domain Hardware Table
BridgePWTable - Bridge Domain Pseudowire Table
BridgeSummary - Bridge summary information
L2VPNCollaborators - L2VPN collaborator information
L2VPNResourceState - L2VPN resource state information
MSTPPortTable - L2VPN MSTP Port Table
MSTPVlanTable - L2VPN MSTP VLAN Table
PseudowireClassTable - List of pseudowire classes
XConnectSummary - XConnect summary information
XConnectTable - XConnect Table
Applicable methods: find_data
XConnectTable
Description: XConnect Table
Parent objects:
L2VPN
Child objects:
XConnect - XConnect information
Applicable filters:
L2VPNInterfaceFilter
L2VPNPseudowireFilter
L2VPNXConnectTypeFilter
L2VPNXConnectStateFilter
L2VPNEncapsulationTypeFilter
L2VPNPseudowireClassFilter
Applicable methods: get_keys, get_entries
XConnect
Description: XConnect information
Parent objects:
XConnectTable
Keys:
GroupName
Type: BoundedString. Length less than or equal to 32
Description: XConnect Group
XConnectName
Type: BoundedString. Length less than or equal to 32
Description: XConnect Name
Value: l2vpn_xc
Applicable methods: get_data
XConnectSummary
Description: XConnect summary information
Parent objects:
L2VPN
Value: l2vpn_xc_summary
Applicable methods: get_data
L2VPNCollaborators
Description: L2VPN collaborator information
Parent objects:
L2VPN
Value: l2vpn_global_info
Applicable methods: get_data
L2VPNResourceState
Description: L2VPN resource state information
Parent objects:
L2VPN
Value: l2vpn_resource_state
Applicable methods: get_data
PseudowireClassTable
Description: List of pseudowire classes
Parent objects:
L2VPN
Child objects:
PseudowireClass - Pseudowire class information
Applicable methods: get_keys, get_entries
PseudowireClass
Description: Pseudowire class information
Parent objects:
PseudowireClassTable
Keys:
PseudowireClassName (mandatory)
Type: BoundedString. Length less than or equal to 32
Description: Pseudowire Class Name
Value: l2vpn_pw_class
Applicable methods: get_data
BridgeDomainTable
Description: Bridge Domain Table
Parent objects:
L2VPN
Child objects:
BridgeDomain - Bridge Domain information
Applicable filters:
L2VPNInterfaceFilter
L2VPNBridgeGroupFilter
L2VPNBridgePseudowireFilter
Applicable methods: get_keys, get_entries
BridgeDomain
Description: Bridge Domain information
Parent objects:
BridgeDomainTable
Keys:
GroupName
Type: BoundedString. Length less than or equal to 32
Description: Bridge Group Name
Name
Type: BoundedString. Length less than or equal to 32
Description: Bridge Domain Name
Value: l2vpn_bridge
Applicable methods: get_data
BridgeACTable
Description: Bridge Domain Attachment Circuit Table
Parent objects:
L2VPN
Child objects:
BridgeAC - Bridge Domain Attachment Circuit
Applicable filters:
L2VPNBridgeFilter
Applicable methods: get_keys, get_entries
BridgeAC
Description: Bridge Domain Attachment Circuit
Parent objects:
BridgeACTable
Keys:
Interface (mandatory)
Type: Interface
Description: Interface
Value: l2vpn_bd_ac
Applicable methods: get_data
BridgePWTable
Description: Bridge Domain Pseudowire Table
Parent objects:
L2VPN
Child objects:
BridgePW - Bridge Domain Pseudowire information
Applicable filters:
L2VPNBridgeFilter
L2VPNBridgeVFIFilter
L2VPNBridgePeerIdFilter
Applicable methods: get_keys, get_entries
BridgePW
Description: Bridge Domain Pseudowire information
Parent objects:
BridgePWTable
Keys:
Neighbor
Type: IPAddress
Description: Neighbor IP address
PseudowireID
Type: Range. Value lies between 1 and -1
Description: Pseudowire ID
Value: l2vpn_bd_pw
Applicable methods: get_data
BridgeAccessPWTable
Description: Bridge Domain Access Pseudowire Table
Parent objects:
L2VPN
Child objects:
BridgeAccessPW - Bridge Domain Access Pseudowire
Applicable filters:
L2VPNBridgeFilter
L2VPNBridgePeerIdFilter
Applicable methods: get_keys, get_entries
BridgeAccessPW
Description: Bridge Domain Access Pseudowire
Parent objects:
BridgeAccessPWTable
Keys:
Neighbor
Type: IPAddress
Description: Neighbor IP address
PseudowireID
Type: Range. Value lies between 1 and -1
Description: Pseudowire ID
Value: l2vpn_bd_pw
Applicable methods: get_data
BridgeSummary
Description: Bridge summary information
Parent objects:
L2VPN
Value: l2vpn_bridge_summary
Applicable methods: get_data
BridgeHardwareTable
Description: Bridge Domain Hardware Table
Parent objects:
L2VPN
Child objects:
BridgeHardware - Bridge Domain Hardware information
Applicable filters:
L2VPNInterfaceFilter
L2VPNBridgeGroupFilter
L2VPNBridgePseudowireFilter
Applicable methods: get_keys, get_entries
BridgeHardware
Description: Bridge Domain Hardware information
Parent objects:
BridgeHardwareTable
Keys:
GroupName
Type: BoundedString. Length less than or equal to 32
Description: Bridge Group Name
Name
Type: BoundedString. Length less than or equal to 32
Description: Bridge Domain Name
Value: l2vpn_bridge_hw
Applicable methods: get_data
MSTPPortTable
Description: L2VPN MSTP Port Table
Parent objects:
L2VPN
Child objects:
MSTPPort - MSTP Port information
Applicable filters:
L2VPN_MSTPMstiFilter
Applicable methods: get_keys, get_entries
MSTPPort
Description: MSTP Port information
Parent objects:
MSTPPortTable
Keys:
Interface (mandatory)
Type: Interface
Description: Interface
Value: l2vpn_mstp_port
Applicable methods: get_data
MSTPVlanTable
Description: L2VPN MSTP VLAN Table
Parent objects:
L2VPN
Child objects:
MSTPVlan - MSTP Port information
Applicable filters:
L2VPN_MSTPMstiFilter
L2VPN_MSTPInterfaceFilter
Applicable methods: get_keys, get_entries
MSTPVlan
Description: MSTP Port information
Parent objects:
MSTPVlanTable
Keys:
VlanID (mandatory)
Type: Range. Value lies between 0 and 4097
Description: vlan id
Value: l2vpn_mstp_vlan
Applicable methods: get_data
L2VPNForwarding
Description: Show L2VPN forwarding
Task IDs required: l2vpn
Parent objects:
Operational
Child objects:
NodeTable - Per node L2VPN forwarding Operational data
Applicable methods: find_data
NodeTable
Description: Per node L2VPN forwarding Operational data
Parent objects:
L2VPNForwarding
Child objects:
Node - The L2VPN forwarding Operational data for a particular node
Applicable methods: get_keys
Node
Description: The L2VPN forwarding Operational data for a particular node
Parent objects:
NodeTable
Keys:
NodeID (mandatory)
Type: NodeID
Description: The identifier for the node
Child objects:
L2FIBBridgeDomainDetailTable - Bridge Domain forwarding detail
L2FIBBridgeDomainNameTable - Bridge Domain forwarding detail
L2FIBBridgeDomainPortTable - Bridge Port forwarding detail
L2FIBMACDetailTable - Bridge MAC detail information
L2FIBMACHardwareEgressTable - Bridge Hardware Egress information
L2FIBMACHardwareIngressTable - Bridge Hardware Ingress information
L2FIBMACIFDetailTable - Bridge MAC Detail information
L2FIBMACIFHardwareEgressTable - Bridge Hardware Egress information
L2FIBMACIFHardwareIngressTable - Bridge Hardware Ingress information
L2FIBSummary - L2FIB Summary information
L2FIB_BDPortHWEgressTable - Bridge Port forwarding detail
L2FIB_BDPortHWIngressTable - Bridge Port forwarding detail
L2FIB_MSTP_DetailTable - MSTP Detail Table
L2FIB_MSTP_SummaryTable - MSTP Summary Table
Applicable methods: find_data
L2FIBBridgeDomainNameTable
Description: Bridge Domain forwarding detail
Parent objects:
Node
Child objects:
L2FIBBridgeDomainName - Specify Bridge Domain Name
Applicable filters:
L2FIBBridgeDomainInterfaceFilter
L2FIBBridgeDomainPseudowireFilter
Applicable methods: get_keys, get_entries
L2FIBBridgeDomainName
Description: Specify Bridge Domain Name
Parent objects:
L2FIBBridgeDomainNameTable
Keys:
BDGroupName
Type: BoundedString. Length less than or equal to 32
Description: Name of the Bridge group
Name
Type: BoundedString. Length less than or equal to 32
Description: Bridge Domain Name
Value: l2fib_bridge_summary_info
Applicable methods: get_data
L2FIBBridgeDomainDetailTable
Description: Bridge Domain forwarding detail
Parent objects:
Node
Child objects:
L2FIBBridgeDomain - Specify Bridge Domain Name
Applicable filters:
L2FIBBridgeDomainInterfaceFilter
L2FIBBridgeDomainPseudowireFilter
Applicable methods: get_keys, get_entries
L2FIBBridgeDomain
Description: Specify Bridge Domain Name
Parent objects:
L2FIBBridgeDomainDetailTable
Keys:
BDGroupName
Type: BoundedString. Length less than or equal to 32
Description: Name of the Bridge group
BdName
Type: BoundedString. Length less than or equal to 32
Description: Bridge Domain Name
Value: l2fib_bridge_info
Applicable methods: get_data
L2FIBBridgeDomainPortTable
Description: Bridge Port forwarding detail
Parent objects:
Node
Child objects:
L2FIBBridgePort - Specify Bridge Domain Name and XC ID
Applicable filters:
L2FIBBridgeDomainNameFilter
L2FIBBridgeDomainInterfaceFilter
L2FIBBridgeDomainPseudowireFilter
Applicable methods: get_keys, get_entries
L2FIBBridgePort
Description: Specify Bridge Domain Name and XC ID
Parent objects:
L2FIBBridgeDomainPortTable
Keys:
GroupName
Type: BoundedString. Length less than or equal to 32
Description: Bridge Group Name
BDName
Type: BoundedString. Length less than or equal to 32
Description: Bridge Domain Name
XCUintID
Type: HexInteger
Description: XC ID
Value: l2fib_bridge_port_detail_info
Applicable methods: get_data
L2FIB_BDPortHWIngressTable
Description: Bridge Port forwarding detail
Parent objects:
Node
Child objects:
L2FIB_BDPortHWIngress - Specify Bridge Domain Name and XC ID
Applicable filters:
L2FIBBridgeDomainNameFilter
L2FIBBridgeDomainInterfaceFilter
L2FIBBridgeDomainPseudowireFilter
Applicable methods: get_keys, get_entries
L2FIB_BDPortHWIngress
Description: Specify Bridge Domain Name and XC ID
Parent objects:
L2FIB_BDPortHWIngressTable
Keys:
GroupName
Type: BoundedString. Length less than or equal to 32
Description: Bridge Group Name
Bdname
Type: BoundedString. Length less than or equal to 32
Description: Bridge Domain Name
XcUintID
Type: HexInteger
Description: XC ID
Value: l2fib_bridge_port_detail_info
Applicable methods: get_data
L2FIB_BDPortHWEgressTable
Description: Bridge Port forwarding detail
Parent objects:
Node
Child objects:
L2FIB_BDPortHWEgress - Specify Bridge Domain Name and XC ID
Applicable filters:
L2FIBBridgeDomainNameFilter
L2FIBBridgeDomainInterfaceFilter
L2FIBBridgeDomainPseudowireFilter
Applicable methods: get_keys, get_entries
L2FIB_BDPortHWEgress
Description: Specify Bridge Domain Name and XC ID
Parent objects:
L2FIB_BDPortHWEgressTable
Keys:
GroupName
Type: BoundedString. Length less than or equal to 32
Description: Bridge Group Name
BridgeName
Type: BoundedString. Length less than or equal to 32
Description: Bridge Domain Name
XconnectUintID
Type: HexInteger
Description: XC ID
Value: l2fib_bridge_port_detail_info
Applicable methods: get_data
L2FIBMACDetailTable
Description: Bridge MAC detail information
Parent objects:
Node
Child objects:
L2FIBMACDetail - MAC Detail information
Applicable filters:
L2FIBBridgeDomainNameFilter
L2FIBMACFilter
Applicable methods: get_keys, get_entries
L2FIBMACDetail
Description: MAC Detail information
Parent objects:
L2FIBMACDetailTable
Keys:
Address
Type: MACAddress
Description: Static MAC address
GroupName
Type: BoundedString. Length less than or equal to 32
Description: Bridge Group Name
Name
Type: BoundedString. Length less than or equal to 32
Description: Bridge Domain Name
Value: l2fib_bridge_mac_info
Applicable methods: get_data
L2FIBMACHardwareIngressTable
Description: Bridge Hardware Ingress information
Parent objects:
Node
Child objects:
L2FIBMACHardwareIngress - MAC Hardware Ingress information
Applicable filters:
L2FIBBridgeDomainNameFilter
L2FIBMACFilter
Applicable methods: get_keys, get_entries
L2FIBMACHardwareIngress
Description: MAC Hardware Ingress information
Parent objects:
L2FIBMACHardwareIngressTable
Keys:
Address
Type: MACAddress
Description: Static MAC address
GroupName
Type: BoundedString. Length less than or equal to 32
Description: Bridge Group Name
Name
Type: BoundedString. Length less than or equal to 32
Description: Bridge Domain Name
Value: l2fib_bridge_mac_info
Applicable methods: get_data
L2FIBMACHardwareEgressTable
Description: Bridge Hardware Egress information
Parent objects:
Node
Child objects:
L2FIBMACHardwareEgress - MAC Hardware Egress information
Applicable filters:
L2FIBBridgeDomainNameFilter
L2FIBMACFilter
Applicable methods: get_keys, get_entries
L2FIBMACHardwareEgress
Description: MAC Hardware Egress information
Parent objects:
L2FIBMACHardwareEgressTable
Keys:
Address
Type: MACAddress
Description: Static MAC address
GroupName
Type: BoundedString. Length less than or equal to 32
Description: Bridge Group Name
Name
Type: BoundedString. Length less than or equal to 32
Description: Bridge Domain Name
Value: l2fib_bridge_mac_info
Applicable methods: get_data
L2FIBMACIFDetailTable
Description: Bridge MAC Detail information
Parent objects:
Node
Child objects:
L2FIBMACIFDetail - MAC Detail information
Applicable filters:
L2FIBBridgeDomainInterfaceFilter
Applicable methods: get_keys, get_entries
L2FIBMACIFDetail
Description: MAC Detail information
Parent objects:
L2FIBMACIFDetailTable
Keys:
Address
Type: MACAddress
Description: Static MAC address
XcUintID
Type: HexInteger
Description: XC ID
GroupName
Type: BoundedString. Length less than or equal to 32
Description: Bridge Group Name
Name
Type: BoundedString. Length less than or equal to 32
Description: Bridge Domain Name
Value: l2fib_bridge_mac_info
Applicable methods: get_data
L2FIBMACIFHardwareIngressTable
Description: Bridge Hardware Ingress information
Parent objects:
Node
Child objects:
L2FIBMACIFHardwareIngress - MAC Hardware Ingress information
Applicable filters:
L2FIBBridgeDomainInterfaceFilter
Applicable methods: get_keys, get_entries
L2FIBMACIFHardwareIngress
Description: MAC Hardware Ingress information
Parent objects:
L2FIBMACIFHardwareIngressTable
Keys:
Address
Type: MACAddress
Description: Static MAC address
XcUintID
Type: HexInteger
Description: XC ID
GroupName
Type: BoundedString. Length less than or equal to 32
Description: Bridge Group Name
Name
Type: BoundedString. Length less than or equal to 32
Description: Bridge Domain Name
Value: l2fib_bridge_mac_info
Applicable methods: get_data
L2FIBMACIFHardwareEgressTable
Description: Bridge Hardware Egress information
Parent objects:
Node
Child objects:
L2FIBMACIFHardwareEgress - MAC Hardware Egress information
Applicable filters:
L2FIBBridgeDomainInterfaceFilter
Applicable methods: get_keys, get_entries
L2FIBMACIFHardwareEgress
Description: MAC Hardware Egress information
Parent objects:
L2FIBMACIFHardwareEgressTable
Keys:
Address
Type: MACAddress
Description: Static MAC address
XcUintID
Type: HexInteger
Description: XC ID
GroupName
Type: BoundedString. Length less than or equal to 32
Description: Bridge Group Name
Name
Type: BoundedString. Length less than or equal to 32
Description: Bridge Domain Name
Value: l2fib_bridge_mac_info
Applicable methods: get_data
L2FIBSummary
Description: L2FIB Summary information
Parent objects:
Node
Value: l2fib_summary_info
Applicable methods: get_data
L2FIB_MSTP_SummaryTable
Description: MSTP Summary Table
Parent objects:
Node
Child objects:
L2FIB_MSTP_Summary - MSTP Summary information
Applicable filters:
L2FIB_MSTP_Filter
Applicable methods: get_keys, get_entries
L2FIB_MSTP_Summary
Description: MSTP Summary information
Parent objects:
L2FIB_MSTP_SummaryTable
Keys:
ParentInterface
Type: Interface
Description: Parent interface context
MSTI
Type: xsd:unsignedInt
Description: MSTI context
Value: l2fib_main_port_mstp_summary_info
Applicable methods: get_data
L2FIB_MSTP_DetailTable
Description: MSTP Detail Table
Parent objects:
Node
Child objects:
L2FIB_MSTP_Detail - MSTP Detail information
Applicable filters:
L2FIB_MSTP_Filter
Applicable methods: get_keys, get_entries
L2FIB_MSTP_Detail
Description: MSTP Detail information
Parent objects:
L2FIB_MSTP_DetailTable
Keys:
ParentInterface
Type: Interface
Description: Parent interface context
MSTI
Type: xsd:unsignedInt
Description: MSTI context
Value: l2fib_main_port_mstp_detail_info
Applicable methods: get_data
Datatypes
XConnectTypeType
Definition: Enumeration. Valid values are:
'LocallySwitched' - Locally switched
'AttachmentCircuit2Pseudowire' - Attachment circuit to pseudowire
XConnectStateType
Definition: Enumeration. Valid values are:
'Unresolved' - XConnect state is unresolved
'Down' - XConnect state is down
'Up' - XConnect state is up
EncapsulationType
Definition: Enumeration. Valid values are:
'MPLS' - MPLS encapsulation
'L2TPv3' - L2TPv3 encapsulation
Filters
L2VPNInterfaceFilter
Description: Interface match
Parameters:
Interface (mandatory)
Type: Interface
Description: Interface
L2VPNXConnectTypeFilter
Description: Match locally switched or attachment circuit to pseudowire
Parameters:
XConnectType (mandatory)
Type: XConnectTypeType
Description: XConnect
L2VPNPseudowireFilter
Description: Neighbor and Pseudowire ID match
Parameters:
Neighbor
Type: IPAddress
Description: Neighbor IP address
PseudowireID
Type: Range. Value lies between 1 and -1
Description: Pseudowire ID
L2VPNXConnectStateFilter
Description: XConnect state match
Parameters:
XConnectState (mandatory)
Type: XConnectStateType
Description: XConnect state
L2VPNEncapsulationTypeFilter
Description: Encapsulation type match
Parameters:
Encapsulation (mandatory)
Type: EncapsulationType
Description: Encapsulation
L2VPNPseudowireClassFilter
Description: Pseudowire class match
Parameters:
PseudowireClass (mandatory)
Type: BoundedString. Length less than or equal to 32
Description: Pseudowire class
L2FIBBridgeDomainInterfaceFilter
Description: Interface match
Parameters:
Interface (mandatory)
Type: Interface
Description: Interface
L2FIBBridgeDomainPseudowireFilter
Description: Neighbor and Pseudowire ID match
Parameters:
NeighborName
Type: IPAddress
Description: Neighbor IP address
PseudowireId
Type: Range. Value lies between 1 and -1
Description: Pseudowire ID
L2FIBBridgeDomainNameFilter
Description: Bridge Name match
Parameters:
BD_Name (mandatory)
Type: BoundedString. Length less than or equal to 32
Description: Name of the bridge domain
L2FIBMACFilter
Description: MAC Address match
Parameters:
Address (mandatory)
Type: MACAddress
Description: Static MAC address
L2VPNBridgeFilter
Description: Bridge Name match
Parameters:
Name (mandatory)
Type: BoundedString. Length less than or equal to 32
Description: Name of the bridge domain
L2VPNBridgePseudowireFilter
Description: Neighbor and Pseudowire ID match
Parameters:
Neighbor
Type: IPAddress
Description: Neighbor IP address
PseudowireID
Type: Range. Value lies between 1 and -1
Description: Pseudowire ID
L2VPNBridgePeerIdFilter
Description: Peer ID match
Parameters:
Neighbor (mandatory)
Type: IPAddress
Description: Neighbor IP address
L2VPNBridgeVFIFilter
Description: Virtual Forwarding Interface match
Parameters:
Name (mandatory)
Type: BoundedString. Length less than or equal to 32
Description: Name of the Virtual Forwarding Interface
L2VPNBridgeGroupFilter
Description: Bridge Group Name match
Parameters:
GroupName (mandatory)
Type: BoundedString. Length less than or equal to 32
Description: Bridge Group Name
L2VPN_MSTPMstiFilter
Description: MSTI ID match
Parameters:
Msti (mandatory)
Type: Range. Value lies between 0 and 64
Description: MSTI ID
L2VPN_MSTPInterfaceFilter
Description: Interface match
Parameters:
Interface (mandatory)
Type: Interface
Description: Interface
L2FIB_MSTP_Filter
Description: L2FIB MSTP Filter
Parameters:
ParentInterface
Type: Interface
Description: Parent interface
MSTI
Type: xsd:unsignedInt
Description: MSTI
Perl Data Object Documentation for ipv4_dhcpd_cfg, version 2. 2.
Objects
IPV4DHCPD
Description: Dhcp Ipv4 configuration
Task IDs required: ip-services
Parent objects:
Configuration
Child objects:
DHCPIPV4 - Dhcp Ipv4 configuration
InterfaceTable - Dhcp Ipv4 Interface Table
ProfileTable - Dhcp Ipv4 Profile Table
VrfTable - Vrf Table
Applicable methods: find_data, set_data, delete_data
DHCPIPV4
Description: Dhcp Ipv4 configuration
Parent objects:
IPV4DHCPD
Values:
Enable (mandatory)
Type: xsd:boolean
Description: dhcp ipv4 is enabled
Default value: none.
Applicable methods: get_data, set_data, delete_data
InterfaceTable
Description: Dhcp Ipv4 Interface Table
Parent objects:
IPV4DHCPD
Child objects:
Interface - Dhcp Ipv4 Interface
Applicable methods: get_keys, set_data, delete_data
Interface
Description: Dhcp Ipv4 Interface
Parent objects:
InterfaceTable
Keys:
IntfName (mandatory)
Type: Interface
Description: Interface Name
Child objects:
None - Disable Dhcp Ipv4
Profile - Profile name and mode
Applicable methods: find_data, set_data, delete_data
Profile
Description: Profile name and mode
Parent objects:
Interface
Values:
ProfileName (mandatory)
Type: xsd:string
Description: Profile name
Mode (mandatory)
Type: IPV4DHCPDModeType
Description: Dhcp mode
Default value: none.
Applicable methods: get_data, set_data, delete_data
None
Description: Disable Dhcp Ipv4
Parent objects:
Interface
Values:
Enable (mandatory)
Type: xsd:boolean
Description: Dhcp Ipv4 disabled
Default value: none.
Applicable methods: get_data, set_data, delete_data
VrfTable
Description: Vrf Table
Parent objects:
IPV4DHCPD
Child objects:
Vrf - VRF table
Applicable methods: get_keys, set_data, delete_data
Vrf
Description: VRF table
Parent objects:
VrfTable
Keys:
VrfName (mandatory)
Type: xsd:string
Description: VRF Name
Child objects:
Profile - Profile name and mode
Applicable methods: find_data, set_data, delete_data
Profile
Description: Profile name and mode
Parent objects:
Vrf
Values:
VRFProfileName (mandatory)
Type: xsd:string
Description: Profile name
Mode (mandatory)
Type: IPV4DHCPDModeType
Description: Dhcp mode
Default value: none.
Applicable methods: get_data, set_data, delete_data
ProfileTable
Description: Dhcp Ipv4 Profile Table
Parent objects:
IPV4DHCPD
Child objects:
Profile - Dhcp Ipv4 Profile
Applicable methods: get_keys, set_data, delete_data
Profile
Description: Dhcp Ipv4 Profile
Parent objects:
ProfileTable
Keys:
ProfileName (mandatory)
Type: xsd:string
Description: Profile Name
Child objects:
ProfileMode - Dhcp Ipv4 Profile mode
Applicable methods: get_keys, set_data, delete_data
ProfileMode
Description: Dhcp Ipv4 Profile mode
Parent objects:
Profile
Keys:
Mode (mandatory)
Type: IPV4DHCPDModeType
Description: Dhcp Ipv4 Profile mode
Child objects:
Mode - Dhcp Ipv4 Profile mode
Proxy - Dhcp Proxy profile
Relay - Dhcp Relay profile
Snoop - Dhcp Snoop profile
Applicable methods: find_data, set_data, delete_data
Mode
Description: Dhcp Ipv4 Profile mode
Parent objects:
ProfileMode
Values:
Enable (mandatory)
Type: xsd:boolean
Description: Dhcp Ipv4 profile
Default value: none.
Applicable methods: get_data, set_data, delete_data
Perl Data Object Documentation for crypto_ipsec_common, version 0. 0.
Datatypes
CryptoIPSecDFBitType
Definition: Enumeration. Valid values are:
'DFBitCopy' - Copy (default for global config)
'DFBitClear' - Clear
'DFBitSet' - Set
CryptoIPSecWindowSize
Definition: Enumeration. Valid values are:
'WinSize64' - Window size of 64 (default)
'WinSize128' - Window size of 128
'WinSize256' - Window size of 256
'WinSize512' - Window size of 512
'WinSize1024' - Window size of 1024
CryptoIPSecPFSType
Definition: Enumeration. Valid values are:
'PFS1' - Diffie-Hellman Group 1
'PFS2' - Diffie-Hellman Group 2
'PFS5' - Diffie-Hellman Group 5
CryptoIPSecProfileType
Definition: Enumeration. Valid values are:
'Static' - IPSec Static Profile
'Dynamic' - IPSec Dynamic Profile
CryptoNameString
Definition: BoundedString. Length less than or equal to 32
CryptoIdleTimeRange
Definition: Range. Value lies between 600 and 86400
CryptoLifetymeKilobytes
Definition: Range. Value lies between 2560 and 4194303
CryptoLifetimeSeconds
Definition: Range. Value lies between 120 and 86400
CryptoSPI
Definition: Range. Value lies between 256 and -1
CryptoDistance
Definition: Range. Value lies between 1 and 255
CryptoTag
Definition: Range. Value lies between 1 and 497777
MIBIPSecFlowMonFailTableSize
Definition: Range. Value lies between 2 and 16000
Perl Data Object Documentation for qos_crs_qfab_cfg, version 7. 0.
Objects
QOS
Description: Global QOS configuration.
Task IDs required: qos
Parent objects:
Configuration
Child objects:
FabricServicePolicy - Global fabric service policy.
Applicable methods: find_data, set_data, delete_data
FabricServicePolicy
Description: Global fabric service policy.
Parent objects:
QOS
Values:
Name (mandatory)
Type: BoundedString. Length less than or equal to 63
Description: Name of the fabric service policy
Default value: none.
Applicable methods: get_data, set_data, delete_data
Datatypes
QOSDummyType1
Definition: xsd:boolean
Perl Data Object Documentation for ip_tcp_sso_oper, version 2. 1.
Objects
TCP_NSR
Description: TCP NSR operational data
Task IDs required: transport
Parent objects:
Operational
Child objects:
NodeTable - Table of information about all nodes present on the system
Applicable methods: find_data
NodeTable
Description: Table of information about all nodes present on the system
Parent objects:
TCP_NSR
Child objects:
Node - Information about a single node
Applicable methods: get_keys
Node
Description: Information about a single node
Parent objects:
NodeTable
Keys:
ID (mandatory)
Type: NodeID
Description: Describing a location
Child objects:
Client - Information about TCP NSR Client
Session - Information about TCP NSR Sessions
SessionSet - Information about TCP NSR Session Sets
Statistics - Statis Information about TCP NSR connections
Applicable methods: find_data
Client
Description: Information about TCP NSR Client
Parent objects:
Node
Child objects:
BriefClientTable - Information about TCP NSR Client
DetailClientTable - Table about TCP NSR Client details
Applicable methods: find_data
BriefClientTable
Description: Information about TCP NSR Client
Parent objects:
Client
Child objects:
BriefClient - Brief information about NSR Client
Applicable methods: get_keys, get_entries
BriefClient
Description: Brief information about NSR Client
Parent objects:
BriefClientTable
Keys:
ID (mandatory)
Type: HexInteger
Description: ID of NSR client
Value: tcp_nsr_ccb_brief_bag
Applicable methods: get_data
DetailClientTable
Description: Table about TCP NSR Client details
Parent objects:
Client
Child objects:
DetailClient - showing detailed information of NSR Clients
Applicable methods: get_keys, get_entries
DetailClient
Description: showing detailed information of NSR Clients
Parent objects:
DetailClientTable
Keys:
ID (mandatory)
Type: HexInteger
Description: ID of NSR client
Value: tcp_nsr_ccb_detailed_bag
Applicable methods: get_data
SessionSet
Description: Information about TCP NSR Session Sets
Parent objects:
Node
Child objects:
BriefSetTable - Information about TCP NSR Session Sets
DetailSetTable - Table about TCP NSR Session Sets details
Applicable methods: find_data
BriefSetTable
Description: Information about TCP NSR Session Sets
Parent objects:
SessionSet
Child objects:
BriefSet - Brief information about NSR Session Sets
Applicable methods: get_keys, get_entries
BriefSet
Description: Brief information about NSR Session Sets
Parent objects:
BriefSetTable
Keys:
ID (mandatory)
Type: HexInteger
Description: ID of NSR Session Set
Value: tcp_nsr_sscb_brief_bag
Applicable methods: get_data
DetailSetTable
Description: Table about TCP NSR Session Sets details
Parent objects:
SessionSet
Child objects:
DetailSet - showing detailed information of NSR Session Sets
Applicable methods: get_keys, get_entries
DetailSet
Description: showing detailed information of NSR Session Sets
Parent objects:
DetailSetTable
Keys:
ID (mandatory)
Type: HexInteger
Description: ID of NSR Sesison Set
Value: tcp_nsr_sscb_detailed_bag
Applicable methods: get_data
Session
Description: Information about TCP NSR Sessions
Parent objects:
Node
Child objects:
BriefSessionTable - Information about TCP NSR Sessions
DetailSessionTable - Table about TCP NSR Sessions details
Applicable methods: find_data
BriefSessionTable
Description: Information about TCP NSR Sessions
Parent objects:
Session
Child objects:
BriefSession - Brief information about NSR Sessions
Applicable methods: get_keys, get_entries
BriefSession
Description: Brief information about NSR Sessions
Parent objects:
BriefSessionTable
Keys:
ID (mandatory)
Type: HexInteger
Description: ID of NSR Sesison
Value: tcp_nsr_pcb_brief_bag
Applicable methods: get_data
DetailSessionTable
Description: Table about TCP NSR Sessions details
Parent objects:
Session
Child objects:
DetailSession - showing detailed information of NSR Sessions
Applicable methods: get_keys, get_entries
DetailSession
Description: showing detailed information of NSR Sessions
Parent objects:
DetailSessionTable
Keys:
ID (mandatory)
Type: HexInteger
Description: ID of NSR Sesison
Value: tcp_nsr_pcb_detailed_bag
Applicable methods: get_data
Statistics
Description: Statis Information about TCP NSR connections
Parent objects:
Node
Child objects:
StatisticClientTable - Table listing NSR connections for which statistic information is provided
StatisticSessionTable - Table listing NSR connections for which statistic information is provided
StatisticSetTable - Table listing NSR connections for which statistic information is provided
Summary - Summary statistics across all NSR connections
Applicable methods: find_data
Summary
Description: Summary statistics across all NSR connections
Parent objects:
Statistics
Value: tcp_nsr_summary_stats_bag
Applicable methods: get_data
StatisticSessionTable
Description: Table listing NSR connections for which statistic information is provided
Parent objects:
Statistics
Child objects:
StatisticSession - showing statistic information of TCP connections
Applicable methods: get_keys, get_entries
StatisticSession
Description: showing statistic information of TCP connections
Parent objects:
StatisticSessionTable
Keys:
ID (mandatory)
Type: HexInteger
Description: ID of TCP connection
Value: tcp_nsr_pcb_stats_bag
Applicable methods: get_data
StatisticClientTable
Description: Table listing NSR connections for which statistic information is provided
Parent objects:
Statistics
Child objects:
StatisticClient - showing statistic information of NSR Clients
Applicable methods: get_keys, get_entries
StatisticClient
Description: showing statistic information of NSR Clients
Parent objects:
StatisticClientTable
Keys:
ID (mandatory)
Type: HexInteger
Description: ID of NSR Client
Value: tcp_nsr_ccb_stats_bag
Applicable methods: get_data
StatisticSetTable
Description: Table listing NSR connections for which statistic information is provided
Parent objects:
Statistics
Child objects:
StatisticSet - showing statistic information of NSR Session Set
Applicable methods: get_keys, get_entries
StatisticSet
Description: showing statistic information of NSR Session Set
Parent objects:
StatisticSetTable
Keys:
ID (mandatory)
Type: HexInteger
Description: ID of NSR Session Set
Value: tcp_nsr_sscb_stats_bag
Applicable methods: get_data
Perl Data Object Documentation for aaa_radius_oper, version 3. 0.
Objects
RADIUS
Description: RADIUS operational data
Parent objects:
AAA
Child objects:
Global - RADIUS Client Information
ServerTable - List of RADIUS servers configured
Applicable methods: find_data
ServerTable
Description: List of RADIUS servers configured
Parent objects:
RADIUS
Child objects:
Server - RADIUS Server
Applicable methods: get_keys, get_entries
Server
Description: RADIUS Server
Parent objects:
ServerTable
Keys:
IPAddress
Type: IPV4Address
Description: IP address of RADIUS server
AuthPortNumber
Type: AAAPortRange
Description: Authentication Port number (standard port 1645)
AcctPortNumber
Type: AAAPortRange
Description: Accounting Port number (standard port 1646)
Value: radius_serverbag
Applicable methods: get_data
Global
Description: RADIUS Client Information
Parent objects:
RADIUS
Value: radius_clientbag
Applicable methods: get_data
Perl Data Object Documentation for ipsla_app_common_oper, version 4. 2.
Objects
IPSLA
Description: IPSLA operational data
Task IDs required: monitor
Parent objects:
Operational
Child objects:
ApplicationInfo - IPSLA application information
MPLSData - MPLS operational data
OperationData - Operations data
Responder - Data from responder probe handling
Applicable methods: find_data
ApplicationInfo
Description: IPSLA application information
Parent objects:
IPSLA
Value: ipsla_application_bag
Applicable methods: get_data
Perl Data Object Documentation for bgp_action, version 7. 0.
Objects
BGP
Description: Container class for BGP action data
Task IDs required: bgp
Parent objects:
Action
Child objects:
ClearMode - Switch BGP into the currently configured mode (standalone or distributed)
DefaultVRF - Default VRF related BGP action
VRFTable - VRF related BGP action
Applicable methods: set_data
DefaultVRF
Description: Default VRF related BGP action
Parent objects:
BGP
Child objects:
AFTable - Container class for the address families supported by BGP
ClearDrops - Clear peer drops
ClearPerformanceStats - Clear BGP performance stats information
Applicable methods: set_data
AFTable
Description: Container class for the address families supported by BGP
Parent objects:
DefaultVRF
VRF
Child objects:
AF - A particular address family
Applicable methods: set_data
AF
Description: A particular address family
Parent objects:
AFTable
Keys:
OAF
Type: BGPOfficialAddressFamilyType
Description: Official address family
SAF
Type: BGPSubsequentAddressFamilyType
Description: Subsequent address family
Child objects:
ClearDampening - Clear dampening statistics
ClearFlapStatistics - Clear flap statistics
ClearNexthop - Clear nexthop
ClearPeer - Clear neighbors
ClearSelfOriginated - Clear redistributed, network and aggregate routes originated by the local system
Applicable methods: set_data
ClearDampening
Description: Clear dampening statistics
Parent objects:
AF
Child objects:
All - Clear the dampening statistics for all neighbors
NetworkTable - Clear dampening statistics for a network table
Applicable methods: set_data
All
Description: Clear the dampening statistics for all neighbors
Parent objects:
ClearDampening
Values:
True (mandatory)
Type: xsd:boolean
Description: Clear value
Default value: none.
Applicable methods: set_data
NetworkTable
Description: Clear dampening statistics for a network table
Parent objects:
ClearDampening
Child objects:
Network - Clear dampening statistics for a network
Applicable methods: set_data
Network
Description: Clear dampening statistics for a network
Parent objects:
NetworkTable
Keys:
Network (mandatory)
Type: IPAddressPrefix
Description: The network in prefix/length format
Values:
True (mandatory)
Type: xsd:boolean
Description: Clear value
Default value: none.
Applicable methods: set_data
ClearSelfOriginated
Description: Clear redistributed, network and aggregate routes originated by the local system
Parent objects:
AF
Values:
True (mandatory)
Type: xsd:boolean
Description: Clear value
Default value: none.
Applicable methods: set_data
ClearFlapStatistics
Description: Clear flap statistics
Parent objects:
AF
Child objects:
AF - Clear flap stats for an address family
NeighborFlapsTable - Clear the flap statistics for a neighbor table
NetworkFlapTable - Clear network flap stats table
RegexpTable - Clear AS paths flap stats regular expression table
RoutePolicyTable - Clear route policy flap stats table
Applicable methods: set_data
AF
Description: Clear flap stats for an address family
Parent objects:
ClearFlapStatistics
Values:
True (mandatory)
Type: xsd:boolean
Description: Clear value
Default value: none.
Applicable methods: set_data
NetworkFlapTable
Description: Clear network flap stats table
Parent objects:
ClearFlapStatistics
Child objects:
NetworkFlap - Clear flap stats for a network
Applicable methods: set_data
NetworkFlap
Description: Clear flap stats for a network
Parent objects:
NetworkFlapTable
Keys:
Network (mandatory)
Type: IPAddressPrefix
Description: The network in prefix/length format
Values:
True (mandatory)
Type: xsd:boolean
Description: Clear value
Default value: none.
Applicable methods: set_data
RoutePolicyTable
Description: Clear route policy flap stats table
Parent objects:
ClearFlapStatistics
Child objects:
RoutePolicy - Table entry to clear flap stats info via route policy
Applicable methods: set_data
RoutePolicy
Description: Table entry to clear flap stats info via route policy
Parent objects:
RoutePolicyTable
Keys:
PolicyName (mandatory)
Type: xsd:string
Description: Route policy name
Values:
True (mandatory)
Type: xsd:boolean
Description: Clear value
Default value: none.
Applicable methods: set_data
RegexpTable
Description: Clear AS paths flap stats regular expression table
Parent objects:
ClearFlapStatistics
Child objects:
Regexp - Clear AS path flap stats via regular expression
Applicable methods: set_data
Regexp
Description: Clear AS path flap stats via regular expression
Parent objects:
RegexpTable
Keys:
RegExp (mandatory)
Type: xsd:string
Description: An encoded regular expression to match the BGP AS paths
Values:
True (mandatory)
Type: xsd:boolean
Description: Clear value
Default value: none.
Applicable methods: set_data
NeighborFlapsTable
Description: Clear the flap statistics for a neighbor table
Parent objects:
ClearFlapStatistics
Child objects:
NeighborFlaps - Clear a neighbors flap statistics
Applicable methods: set_data
NeighborFlaps
Description: Clear a neighbors flap statistics
Parent objects:
NeighborFlapsTable
Keys:
Neighbor (mandatory)
Type: IPAddress
Description: Neighbor address
Values:
True (mandatory)
Type: xsd:boolean
Description: Clear value
Default value: none.
Applicable methods: set_data
ClearPeer
Description: Clear neighbors
Parent objects:
AF
Child objects:
ASTable - Clear a group of neighbors with a given AS table
All - Clear all neighbors. CLI note: 'Graceful' is only available if 'PrefixFilter' is FALSE and 'Direction' is 'Hard' and afi/safi is 'all/all'. 'Graceful' and 'PrefixFilter' values of FALSE mean not to apply them.
External - Clear all external neighbors
NeighborTable - Clear a neighbor table
OutOfMemoryShutdown - Clear all neighbors which were shut down due to low memory
Applicable methods: set_data
All
Description: Clear all neighbors. CLI note: 'Graceful' is only available if 'PrefixFilter' is FALSE and 'Direction' is 'Hard' and afi/safi is 'all/all'. 'Graceful' and 'PrefixFilter' values of FALSE mean not to apply them.
Parent objects:
ClearPeer
Values:
Direction
Type: BGPClearDirectionType
Description: Clear direction
PrefixFilter
Type: xsd:boolean
Description: TRUE to apply an outbound prefix filter
Graceful
Type: xsd:boolean
Description: Clear gracefully
Default value: none.
Applicable methods: set_data
NeighborTable
Description: Clear a neighbor table
Parent objects:
ClearPeer
Child objects:
Neighbor - Clear a neighbor
Applicable methods: set_data
Neighbor
Description: Clear a neighbor
Parent objects:
NeighborTable
Keys:
Neighbor (mandatory)
Type: IPAddress
Description: Neighbor address
Values:
Direction
Type: BGPClearDirectionType
Description: Clear direction
PrefixFilter
Type: xsd:boolean
Description: TRUE to apply an outbound prefix filter
Graceful
Type: xsd:boolean
Description: Clear gracefully
Default value: none.
Applicable methods: set_data
ASTable
Description: Clear a group of neighbors with a given AS table
Parent objects:
ClearPeer
Child objects:
AS - Clear a group of neighbors with a given AS
Applicable methods: set_data
AS
Description: Clear a group of neighbors with a given AS
Parent objects:
ASTable
Keys:
AS_XX
Type: BGP_ASRange
Description: xx of AS number xx.yy
AS_YY
Type: BGP_ASRange
Description: yy of AS number xx.yy
Values:
Direction
Type: BGPClearDirectionType
Description: Clear direction
PrefixFilter
Type: xsd:boolean
Description: TRUE to apply an outbound prefix filter
Graceful
Type: xsd:boolean
Description: Clear gracefully
Default value: none.
Applicable methods: set_data
External
Description: Clear all external neighbors
Parent objects:
ClearPeer
Values:
Direction
Type: BGPClearDirectionType
Description: Clear direction
PrefixFilter
Type: xsd:boolean
Description: TRUE to apply an outbound prefix filter
Graceful
Type: xsd:boolean
Description: Clear gracefully
Default value: none.
Applicable methods: set_data
OutOfMemoryShutdown
Description: Clear all neighbors which were shut down due to low memory
Parent objects:
ClearPeer
Values:
Direction
Type: BGPClearDirectionType
Description: Clear direction
PrefixFilter
Type: xsd:boolean
Description: TRUE to apply an outbound prefix filter
Graceful
Type: xsd:boolean
Description: Clear gracefully
Default value: none.
Applicable methods: set_data
ClearNexthop
Description: Clear nexthop
Parent objects:
AF
Child objects:
PerformanceStatistics - Performance statistics information related to processing
RegistrationNexthop - Registration with RIB and reregister
Applicable methods: set_data
PerformanceStatistics
Description: Performance statistics information related to processing
Parent objects:
ClearNexthop
Values:
True (mandatory)
Type: xsd:boolean
Description: Clear value
Default value: none.
Applicable methods: set_data
RegistrationNexthop
Description: Registration with RIB and reregister
Parent objects:
ClearNexthop
Child objects:
Nexthop - Nexthop to be re-reregistered
Applicable methods: set_data
Nexthop
Description: Nexthop to be re-reregistered
Parent objects:
RegistrationNexthop
Keys:
Nexthop (mandatory)
Type: IPAddress
Description: Nexthop address
Values:
True (mandatory)
Type: xsd:boolean
Description: Clear value
Default value: none.
Applicable methods: set_data
ClearPerformanceStats
Description: Clear BGP performance stats information
Parent objects:
DefaultVRF
VRF
Values:
True (mandatory)
Type: xsd:boolean
Description: Clear value
Default value: none.
Applicable methods: set_data
ClearDrops
Description: Clear peer drops
Parent objects:
DefaultVRF
VRF
Child objects:
All - Clear peer drop info for all neighbors
NeighborDropsTable - Clear neighbor peer drops table
Applicable methods: set_data
All
Description: Clear peer drop info for all neighbors
Parent objects:
ClearDrops
Values:
True (mandatory)
Type: xsd:boolean
Description: Clear value
Default value: none.
Applicable methods: set_data
NeighborDropsTable
Description: Clear neighbor peer drops table
Parent objects:
ClearDrops
Child objects:
NeighborDrops - Clear the peer drop info for a neighbor
Applicable methods: set_data
NeighborDrops
Description: Clear the peer drop info for a neighbor
Parent objects:
NeighborDropsTable
Keys:
Neighbor (mandatory)
Type: IPAddress
Description: Neighbor address
Values:
True (mandatory)
Type: xsd:boolean
Description: Clear value
Default value: none.
Applicable methods: set_data
VRFTable
Description: VRF related BGP action
Parent objects:
BGP
Child objects:
VRF - Actions for a particular VRF
Applicable methods: set_data
VRF
Description: Actions for a particular VRF
Parent objects:
VRFTable
Keys:
VrfName (mandatory)
Type: xsd:string
Description: Name of the VRF
Child objects:
AFTable - Container class for the address families supported by BGP
ClearDrops - Clear peer drops
ClearPerformanceStats - Clear BGP performance stats information
Applicable methods: set_data
ClearMode
Description: Switch BGP into the currently configured mode (standalone or distributed)
Parent objects:
BGP
Values:
True (mandatory)
Type: xsd:boolean
Description: Clear value
Default value: none.
Applicable methods: set_data
Datatypes
BGPClearDirectionType
Definition: Enumeration. Valid values are:
'Hard' - Hard Reset
'SoftInbound' - Soft inbound
'SoftOutbound' - Soft outbound
'Both' - Soft inbound and outbound
Perl Data Object Documentation for ipsla_op_def_path_hourly_cfg, version 7. 2.
Objects
Statistics
Description: Statistics collection aggregated over an hour
Parent objects:
ICMPPathEcho
Child objects:
DistCount - Count of distribution intervals maintained
DistInterval - Distribution interval length
Hops - Maximum hops per path for which statistics are kept
Hours - Number of hours for which hourly statistics are kept
Paths - Maximum number of paths for which statistics are kept
Applicable methods: find_data, set_data, delete_data
DistCount
Description: Count of distribution intervals maintained
Parent objects:
Statistics
Values:
DistIntervalCount (mandatory)
Type: Range. Value lies between 1 and 20
Description: Specify number of distribution intervals
Default value:
DistIntervalCount => 1
Applicable methods: get_data, set_data, delete_data
DistInterval
Description: Distribution interval length
Parent objects:
Statistics
Values:
DistInterval (mandatory)
Type: Range. Value lies between 1 and 100
Description: Specify distribution interval in milliseconds
Default value:
DistInterval => 20
Applicable methods: get_data, set_data, delete_data
Hours
Description: Number of hours for which hourly statistics are kept
Parent objects:
Statistics
Values:
HoursCount (mandatory)
Type: Range. Value lies between 0 and 25
Description: Specify number of hours
Default value:
HoursCount => 2
Applicable methods: get_data, set_data, delete_data
Hops
Description: Maximum hops per path for which statistics are kept
Parent objects:
Statistics
Values:
HopsCount (mandatory)
Type: Range. Value lies between 1 and 30
Description: Specify number of hops
Default value:
HopsCount => 16
Applicable methods: get_data, set_data, delete_data
Paths
Description: Maximum number of paths for which statistics are kept
Parent objects:
Statistics
Values:
PathCount (mandatory)
Type: Range. Value lies between 1 and 128
Description: Specify number of paths
Default value:
PathCount => 5
Applicable methods: get_data, set_data, delete_data
Perl Data Object Documentation for ipv4_pim_oper, version 6. 0.
Objects
PIM
Description: PIM operational data
Task IDs required: multicast
Parent objects:
Operational
Child objects:
BSR - PIM BSR Information
BidirDFStateTable - Bidirectional PIM DF Election State Table
BidirDFWinnerTable - Bidirectional PIM DF Election Winner Table
GroupMapMatchRPFTable - Find the Matching Group-Mapping for the specified Group Address
GroupMapMatchSrcTable - Find the Matching Group-Mapping with source information on specified Group Address
GroupMapRPFTable - PIM Group Mapping Information
GroupMapSrcTable - PIM Group Mapping with source information
InterfaceTable - PIM Interfaces
JPStatsTable - PIM Join Prune Statistics Table
NSF - PIM NSF Information
NeighborSummaryTable - PIM Neighbor Summary Table
NeighborTable - PIM Neighbor Table
RPFHashS - PIM RPF Hash Outcome for S
RPFHashSG - PIM RPF Hash Outcome for S,G
RPFNbrTable - PIM RPF Neighbor Table
RPFTable - PIM RPF Information Table
RPFTableSummary - PIM RPF Registration Summary
RangeListTable - PIM Range List Information
Summary - PIM Summary Information
TopologyTable - PIM Topology Table
TopologyTableCount - Route count information from PIM Topology Table
TrafficCounters - PIM Message Traffic Counters
TunnelPIMInfoTable - Tunnels Info that PIM has
Applicable methods: find_data
BidirDFWinnerTable
Description: Bidirectional PIM DF Election Winner Table
Parent objects:
PIM
Child objects:
BidirDFWinner - Bidirectional PIM DF Election Table Entry
Applicable filters:
PIM_RPAddressFilter
PIMInterfaceFilter
Applicable methods: get_keys, get_entries
BidirDFWinner
Description: Bidirectional PIM DF Election Table Entry
Parent objects:
BidirDFWinnerTable
Keys:
RPAddress
Type: IPAddress
Description: RP Address
Name
Type: Interface
Description: Interface Name
Value: pim_bidir_df_bag
Applicable methods: get_data
BidirDFStateTable
Description: Bidirectional PIM DF Election State Table
Parent objects:
PIM
Child objects:
BidirDFState - Bidirectional PIM DF Election Table Entry
Applicable filters:
PIM_RPAddressFilter
PIMInterfaceFilter
Applicable methods: get_keys, get_entries
BidirDFState
Description: Bidirectional PIM DF Election Table Entry
Parent objects:
BidirDFStateTable
Keys:
RPAddress
Type: IPAddress
Description: RP Address
Name
Type: Interface
Description: Interface Name
Value: pim_bidir_df_state_bag
Applicable methods: get_data
NSF
Description: PIM NSF Information
Parent objects:
PIM
Value: pim_nsf_bag
Applicable methods: get_data
TopologyTable
Description: PIM Topology Table
Parent objects:
PIM
Child objects:
Topology - PIM Topology Information
Applicable filters:
PIMSourceGroupAddressFilter
PIMGroupAddressFilter
PIMSourceAddressFilter
Applicable methods: get_keys, get_entries
Topology
Description: PIM Topology Information
Parent objects:
TopologyTable
Keys:
SourceAddress
Type: IPAddress
Description: Source Address
GroupAddress
Type: IPAddress
Description: Group Address
RPT
Type: xsd:unsignedInt
Description: RPT bit
Value: pim_tt_route_bag
Applicable methods: get_data
TopologyTableCount
Description: Route count information from PIM Topology Table
Parent objects:
PIM
Value: pim_tt_summ_bag
Applicable methods: get_data
RangeListTable
Description: PIM Range List Information
Parent objects:
PIM
Child objects:
RangeList - PIM Range List Information
Applicable filters:
PIM_RPAddressFilter
PIMClientFilter
Applicable methods: get_keys, get_entries
RangeList
Description: PIM Range List Information
Parent objects:
RangeListTable
Keys:
RPAddress
Type: IPAddress
Description: RP Address
Client
Type: PIMClientType
Description: Client
Value: pim_rl_bag
Applicable methods: get_data
GroupMapRPFTable
Description: PIM Group Mapping Information
Parent objects:
PIM
Child objects:
GroupMapRPF - PIM Group Mapping Entry
Applicable methods: get_keys, get_entries
GroupMapRPF
Description: PIM Group Mapping Entry
Parent objects:
GroupMapRPFTable
Keys:
Prefix
Type: IPAddress
Description: Prefix
PrefixLength
Type: xsd:unsignedInt
Description: Prefix Length
Client
Type: PIMClientType
Description: Client
Protocol
Type: PIMProtocolType
Description: Protocol
RPAddress
Type: IPAddress
Description: RP Address
RPPriority
Type: xsd:unsignedInt
Description: RP Priority
Value: pim_grp_map_inforpf_bag
Applicable methods: get_data
GroupMapMatchRPFTable
Description: Find the Matching Group-Mapping for the specified Group Address
Parent objects:
PIM
Child objects:
GroupMapMatchRPF - PIM Group Matching Mapping Entry
Applicable methods: get_keys, get_entries
GroupMapMatchRPF
Description: PIM Group Matching Mapping Entry
Parent objects:
GroupMapMatchRPFTable
Keys:
GroupAddress (mandatory)
Type: IPAddress
Description: Group Address
Value: pim_grp_map_inforpf_bag
Applicable methods: get_data
GroupMapSrcTable
Description: PIM Group Mapping with source information
Parent objects:
PIM
Child objects:
GroupMapSrc - PIM Group Mapping Entry with source information
Applicable methods: get_keys, get_entries
GroupMapSrc
Description: PIM Group Mapping Entry with source information
Parent objects:
GroupMapSrcTable
Keys:
Prefix
Type: IPV4Mask
Description: Prefix
PrefixLength
Type: xsd:unsignedInt
Description: Prefix Length
Client
Type: PIMClientType
Description: Client
Protocol
Type: PIMProtocolType
Description: Protocol
RPAddress
Type: IPAddress
Description: RP Address
Value: pim_grp_map_infosrc_bag
Applicable methods: get_data
GroupMapMatchSrcTable
Description: Find the Matching Group-Mapping with source information on specified Group Address
Parent objects:
PIM
Child objects:
GroupMapMatchSrc - PIM Group Matching Mapping Entry with source information
Applicable methods: get_keys, get_entries
GroupMapMatchSrc
Description: PIM Group Matching Mapping Entry with source information
Parent objects:
GroupMapMatchSrcTable
Keys:
GroupAddress (mandatory)
Type: IPAddress
Description: Group Address
Value: pim_grp_map_infosrc_bag
Applicable methods: get_data
InterfaceTable
Description: PIM Interfaces
Parent objects:
PIM
Child objects:
Interface - PIM Interface
Applicable filters:
PIMInterfaceStateOnFilter
PIMInterfaceStateOffFilter
Applicable methods: get_keys, get_entries
Interface
Description: PIM Interface
Parent objects:
InterfaceTable
Keys:
Name (mandatory)
Type: Interface
Description: Interface Name
Value: pim_idb_bag
Applicable methods: get_data
NeighborTable
Description: PIM Neighbor Table
Parent objects:
PIM
Child objects:
Neighbor - PIM Neighbor Information
Applicable filters:
PIMInterfaceFilter
Applicable methods: get_keys, get_entries
Neighbor
Description: PIM Neighbor Information
Parent objects:
NeighborTable
Keys:
InterfaceName
Type: Interface
Description: Interface Name
Neighboraddress
Type: IPAddress
Description: Neighbor Address
Value: pim_nbr_bag
Applicable methods: get_data
NeighborSummaryTable
Description: PIM Neighbor Summary Table
Parent objects:
PIM
Child objects:
NeighborSummary - PIM Neighbor Summary Information
Applicable methods: get_keys, get_entries
NeighborSummary
Description: PIM Neighbor Summary Information
Parent objects:
NeighborSummaryTable
Keys:
InterfaceName (mandatory)
Type: Interface
Description: Interface Name
Value: pim_nbr_summ_bag
Applicable methods: get_data
TunnelPIMInfoTable
Description: Tunnels Info that PIM has
Parent objects:
PIM
Child objects:
TunnelPIMInfo - PIM Tunnel Information
Applicable methods: get_keys, get_entries
TunnelPIMInfo
Description: PIM Tunnel Information
Parent objects:
TunnelPIMInfoTable
Keys:
TunnelName (mandatory)
Type: xsd:string
Description: Tunnel Name
Value: pim_tunnel_info_bag
Applicable methods: get_data
RPFTable
Description: PIM RPF Information Table
Parent objects:
PIM
Child objects:
RPF - PIM RPF Information
Applicable methods: get_keys, get_entries
RPF
Description: PIM RPF Information
Parent objects:
RPFTable
Keys:
RegisteredAddress (mandatory)
Type: IPAddress
Description: Address for which RPF lookup
Value: pim_rpf_info_bag
Applicable methods: get_data
RPFTableSummary
Description: PIM RPF Registration Summary
Parent objects:
PIM
Value: pim_rpf_summary_bag
Applicable methods: get_data
RPFHashS
Description: PIM RPF Hash Outcome for S
Parent objects:
PIM
Value: pim_rpf_hash_bag
Applicable methods: get_data
RPFHashSG
Description: PIM RPF Hash Outcome for S,G
Parent objects:
PIM
Value: pim_rpf_hash_bag
Applicable methods: get_data
RPFNbrTable
Description: PIM RPF Neighbor Table
Parent objects:
PIM
Child objects:
RPFNeighbor - PIM RPF RIB Neighbor
Applicable methods: get_keys, get_entries
RPFNeighbor
Description: PIM RPF RIB Neighbor
Parent objects:
RPFNbrTable
Keys:
InterfaceName
Type: Interface
Description: Interface Name
RIBNbrAddress
Type: IPAddress
Description: RPF neighbor address to lookup
Value: pim_rpf_nbr_bag
Applicable methods: get_data
JPStatsTable
Description: PIM Join Prune Statistics Table
Parent objects:
PIM
Child objects:
JPStats - PIM Join Prune Statistics
Applicable methods: get_keys, get_entries
JPStats
Description: PIM Join Prune Statistics
Parent objects:
JPStatsTable
Keys:
Name (mandatory)
Type: Interface
Description: Interface Name
Value: pim_jpstats_bag
Applicable methods: get_data
TrafficCounters
Description: PIM Message Traffic Counters
Parent objects:
PIM
Value: pim_traffic_bag
Applicable methods: get_data
Summary
Description: PIM Summary Information
Parent objects:
PIM
Value: pim_summary_bag
Applicable methods: get_data
BSR
Description: PIM BSR Information
Parent objects:
PIM
Child objects:
BSRElection - PIM BSR election state
BSRRPCache - PIM BSR RP Cache
CandidateRP - PIM Candidate-RP
Applicable methods: find_data
BSRElection
Description: PIM BSR election state
Parent objects:
BSR
Child objects:
BSRInfo - PIM BSR Information
Applicable methods: get_keys, get_entries
BSRInfo
Description: PIM BSR Information
Parent objects:
BSRElection
Keys:
PIMScope (mandatory)
Type: xsd:unsignedInt
Description: Scope
Value: pim_bsr_election_bag
Applicable methods: get_data
BSRRPCache
Description: PIM BSR RP Cache
Parent objects:
BSR
Child objects:
RPCacheTable - PIM BSR RP Cache
Applicable methods: get_keys, get_entries
RPCacheTable
Description: PIM BSR RP Cache
Parent objects:
BSRRPCache
Keys:
GrpPrefix (mandatory)
Type: IPAddress
Description: Group Prefix
Value: pim_bsr_rp_cache_bag
Applicable methods: get_data
CandidateRP
Description: PIM Candidate-RP
Parent objects:
BSR
Child objects:
CRPInfo - PIM BSR CRP Information
Applicable methods: get_keys, get_entries
CRPInfo
Description: PIM BSR CRP Information
Parent objects:
CandidateRP
Keys:
CRPAddress (mandatory)
Type: IPAddress
Description: Candidate-RP Address
Value: pim_bsr_candidate_rp_bag
Applicable methods: get_data
Datatypes
PIMProtocolType
Definition: Enumeration. Valid values are:
'NonRoutable' - Non-Routable
'SparseMode' - Sparse Mode
'DenseMode' - Dense Mode
'Bidir' - Bidirectional Mode
'SSM' - Source Specific Multicast Mode
PIMClientType
Definition: Enumeration. Valid values are:
'NoClient' - No Client
'Permanent' - Permanent
'AutoRP' - AutoRP
'BSR' - BSR
'Configured' - Configured
'Static' - Static
Filters
PIM_RPAddressFilter
Description: Filter based on RP Address
Parameters:
RPAddress (mandatory)
Type: IPAddress
Description: RP Address
PIMInterfaceFilter
Description: Filter based on the Interface
Parameters:
Name (mandatory)
Type: Interface
Description: Interface name
PIMSourceGroupAddressFilter
Description: Filter based on Source and Group Addresses
Parameters:
SourceAddress
Type: IPAddress
Description: Source Address
GroupAddress
Type: IPAddress
Description: Group Address
PIMGroupAddressFilter
Description: Filter based on Group Address
Parameters:
GroupAddress (mandatory)
Type: IPAddress
Description: Group Address
PIMSourceAddressFilter
Description: Filter based on Source Address
Parameters:
SourceAddress (mandatory)
Type: IPAddress
Description: Source Address
PIMClientFilter
Description: Filter based on the source of Info (the client number)
Parameters:
Client (mandatory)
Type: PIMClientType
Description: Client
PIMInterfaceStateOnFilter
Description: Filter in only interfaces that are PIM enabled
Parameters:
PIMInterfaceStateOffFilter
Description: Filter in only interfaces that are PIM disabled
Parameters:
Perl Data Object Documentation for daps_ipv4_cfg, version 1. 0.
Objects
Ipv4Pool
Description: Configure IPv4 Pool
Task IDs required: ip-services
Parent objects:
Configuration
Child objects:
Ipv4PoolUtilizationMarkTable - Configure utilization thresholds for all pools
VrfTable - Specify VRF of pool
Applicable methods: find_data, set_data, delete_data
Ipv4PoolUtilizationMarkTable
Description: Configure utilization thresholds for all pools
Parent objects:
Ipv4Pool
Child objects:
UtilizationMarkHigh - High utilization mark
UtilizationMarkLow - Low utilization mark
Applicable methods: find_data, set_data, delete_data
UtilizationMarkLow
Description: Low utilization mark
Parent objects:
Ipv4PoolUtilizationMarkTable
Values:
LowUtil (mandatory)
Type: Range. Value lies between 1 and 100
Description: Specify numerical value as percentage
Default value: none.
Applicable methods: get_data, set_data, delete_data
UtilizationMarkHigh
Description: High utilization mark
Parent objects:
Ipv4PoolUtilizationMarkTable
Values:
HighUtil (mandatory)
Type: Range. Value lies between 1 and 100
Description: Specify numerical value as percentage
Default value: none.
Applicable methods: get_data, set_data, delete_data
VrfTable
Description: Specify VRF of pool
Parent objects:
Ipv4Pool
Child objects:
Vrf - none
Applicable methods: get_keys, set_data, delete_data
Vrf
Description: none
Parent objects:
VrfTable
Keys:
VrfName
Type: xsd:string
Description: Specify VRF name
PoolName
Type: xsd:string
Description: Specify pool name
Child objects:
AddressRangeTable - Specify address range for allocation
Enter - Create or enter pool configuration mode
ExcludeTable - Exclude addresses from pool
NetworkTable - Specify network for allocation
VrfUtilizationMarkTable - Specify utilization mark
Applicable methods: find_data, set_data, delete_data
Enter
Description: Create or enter pool configuration mode
Parent objects:
Vrf
Values:
Enable (mandatory)
Type: xsd:boolean
Description: none
Default value: none.
Applicable methods: get_data, set_data, delete_data
AddressRangeTable
Description: Specify address range for allocation
Parent objects:
Vrf
Child objects:
AddressRange - Specify address range
Applicable methods: get_keys, get_entries, set_data, delete_data
AddressRange
Description: Specify address range
Parent objects:
AddressRangeTable
Keys:
RangeStart
Type: IPV4Address
Description: Specify first address in range
RangeEnd
Type: IPV4Address
Description: Specify last address in range
Values:
Enable (mandatory)
Type: xsd:boolean
Description: none
Default value: none.
Applicable methods: get_data, set_data, delete_data
ExcludeTable
Description: Exclude addresses from pool
Parent objects:
Vrf
Child objects:
Exclude - Specify excluded address range
Applicable methods: get_keys, get_entries, set_data, delete_data
Exclude
Description: Specify excluded address range
Parent objects:
ExcludeTable
Keys:
RangeStart
Type: IPV4Address
Description: First address in range
RangeEnd
Type: IPV4Address
Description: Last address in range
Values:
Enable (mandatory)
Type: xsd:boolean
Description: none
Default value: none.
Applicable methods: get_data, set_data, delete_data
NetworkTable
Description: Specify network for allocation
Parent objects:
Vrf
Child objects:
Network - IP prefix <network/length>
Applicable methods: get_keys, get_entries, set_data, delete_data
Network
Description: IP prefix <network/length>
Parent objects:
NetworkTable
Keys:
Ipv4Address
Type: IPV4Address
Description: IPv4 prefix
Ipv4Mask
Type: IPV4Mask
Description: Ipv4 mask
Values:
Enable (mandatory)
Type: xsd:boolean
Description: none
Default value: none.
Applicable methods: get_data, set_data, delete_data
VrfUtilizationMarkTable
Description: Specify utilization mark
Parent objects:
Vrf
Child objects:
VrfUtilizationMarkHigh - High utilization mark
VrfUtilizationMarkLow - Low utilization mark
Applicable methods: find_data, set_data, delete_data
VrfUtilizationMarkLow
Description: Low utilization mark
Parent objects:
VrfUtilizationMarkTable
Values:
LowUtil (mandatory)
Type: Range. Value lies between 1 and 100
Description: Specify numerical value as percentage
Default value: none.
Applicable methods: get_data, set_data, delete_data
VrfUtilizationMarkHigh
Description: High utilization mark
Parent objects:
VrfUtilizationMarkTable
Values:
HighUtil (mandatory)
Type: Range. Value lies between 1 and 100
Description: Specify numerical value as percentage
Default value: none.
Applicable methods: get_data, set_data, delete_data
Perl Data Object Documentation for crypto_cepki_oper, version 2. 0.
Objects
CryptoCertificateAuthority
Description: Public Key Infrastructure Related Information
Task IDs required: crypto
Parent objects:
Operational
Child objects:
TrustpointTable - CA Trustpoint Table Information
Applicable methods: find_data
TrustpointTable
Description: CA Trustpoint Table Information
Parent objects:
CryptoCertificateAuthority
Child objects:
Trustpoint - Certificate Information for a particular Trustpoint
Applicable methods: get_keys
Trustpoint
Description: Certificate Information for a particular Trustpoint
Parent objects:
TrustpointTable
Keys:
Name (mandatory)
Type: xsd:string
Description: The Trustpoint to query
Child objects:
CertificateAuthorityCertificate - Certificate Authority Certificate Attributes
RouterCertificate - Router Certificate Attributes
RouterEncryptionCertificate - Router Encryption Certificate Attributes
RouterSignatureCertificate - Router Signature Certificate Attributes
Applicable methods: find_data
CertificateAuthorityCertificate
Description: Certificate Authority Certificate Attributes
Parent objects:
Trustpoint
Child objects:
CRLDistributionPointTable - Router Certificates CRLDistributionPoint Table
CertificateExpiresOn - Valid before date of the Certificate, in seconds since 00:00:00 UTC, January 1, 1970
CertificateValidFrom - Valid from date of the Certificate, in seconds since 00:00:00 UTC, January 1, 1970
Issuer - Issuer Name of the Certificate
Subject - Subject Name of the Certificate
Applicable methods: find_data
Issuer
Description: Issuer Name of the Certificate
Parent objects:
CertificateAuthorityCertificate
RouterCertificate
RouterSignatureCertificate
RouterEncryptionCertificate
Values:
Name (mandatory)
Type: xsd:string
Description: Issuer Name of the Certificate
Default value: none.
Applicable methods: get_data
Subject
Description: Subject Name of the Certificate
Parent objects:
CertificateAuthorityCertificate
RouterCertificate
RouterSignatureCertificate
RouterEncryptionCertificate
Values:
Name (mandatory)
Type: xsd:string
Description: Subject Name of the Certificate
Default value: none.
Applicable methods: get_data
CertificateValidFrom
Description: Valid from date of the Certificate, in seconds since 00:00:00 UTC, January 1, 1970
Parent objects:
CertificateAuthorityCertificate
RouterCertificate
RouterSignatureCertificate
RouterEncryptionCertificate
Values:
Value (mandatory)
Type: xsd:unsignedInt
Description: Valid from date of the Certificate
Default value: none.
Applicable methods: get_data
CertificateExpiresOn
Description: Valid before date of the Certificate, in seconds since 00:00:00 UTC, January 1, 1970
Parent objects:
CertificateAuthorityCertificate
RouterCertificate
RouterSignatureCertificate
RouterEncryptionCertificate
Values:
Value (mandatory)
Type: xsd:unsignedInt
Description: Valid before date of the Certificate
Default value: none.
Applicable methods: get_data
CRLDistributionPointTable
Description: Router Certificates CRLDistributionPoint Table
Parent objects:
CertificateAuthorityCertificate
RouterCertificate
RouterSignatureCertificate
RouterEncryptionCertificate
Child objects:
CRLDistributionPoint - Certificate CRLDistributionPoint Instance
Applicable methods: get_keys, get_entries
CRLDistributionPoint
Description: Certificate CRLDistributionPoint Instance
Parent objects:
CRLDistributionPointTable
Keys:
Index (mandatory)
Type: xsd:unsignedInt
Description: CDP Entry Index
Values:
CDPContent (mandatory)
Type: xsd:string
Description: CRLDistributionPoint Content
Default value: none.
Applicable methods: get_data
RouterCertificate
Description: Router Certificate Attributes
Parent objects:
Trustpoint
Child objects:
CRLDistributionPointTable - Router Certificates CRLDistributionPoint Table
CertificateExpiresOn - Valid before date of the Certificate, in seconds since 00:00:00 UTC, January 1, 1970
CertificateValidFrom - Valid from date of the Certificate, in seconds since 00:00:00 UTC, January 1, 1970
Issuer - Issuer Name of the Certificate
Subject - Subject Name of the Certificate
Applicable methods: find_data
RouterSignatureCertificate
Description: Router Signature Certificate Attributes
Parent objects:
Trustpoint
Child objects:
CRLDistributionPointTable - Router Certificates CRLDistributionPoint Table
CertificateExpiresOn - Valid before date of the Certificate, in seconds since 00:00:00 UTC, January 1, 1970
CertificateValidFrom - Valid from date of the Certificate, in seconds since 00:00:00 UTC, January 1, 1970
Issuer - Issuer Name of the Certificate
Subject - Subject Name of the Certificate
Applicable methods: find_data
RouterEncryptionCertificate
Description: Router Encryption Certificate Attributes
Parent objects:
Trustpoint
Child objects:
CRLDistributionPointTable - Router Certificates CRLDistributionPoint Table
CertificateExpiresOn - Valid before date of the Certificate, in seconds since 00:00:00 UTC, January 1, 1970
CertificateValidFrom - Valid from date of the Certificate, in seconds since 00:00:00 UTC, January 1, 1970
Issuer - Issuer Name of the Certificate
Subject - Subject Name of the Certificate
Applicable methods: find_data
Perl Data Object Documentation for service-sbc-infra_oper, version 1. 0.
Objects
Sbc
Description: SBC operational Data
Parent objects:
Operational
Child objects:
SbcProcess - Operational data for a particular SBC instance
Applicable methods: get_keys
SbcProcess
Description: Operational data for a particular SBC instance
Parent objects:
Sbc
Keys:
InstanceName (mandatory)
Type: xsd:string
Description: SBC Instance
Child objects:
SbcNotifications - Notification and Alarm data
Applicable methods: find_data
SbcNotifications
Description: Notification and Alarm data
Parent objects:
SbcProcess
Child objects:
iccInstanceAlarm - The overall alarm state of the SBC has changed
iccOperStatusNotification - The operational status of the SBC has changed
iccSigStackAlarm - Notifies that activation of a signaling stack has failed
rpsRoutingActionAlarm - A routing action refers to a signaling stack that is not active
Applicable methods: find_data
iccInstanceAlarm
Description: The overall alarm state of the SBC has changed
Parent objects:
SbcNotifications
Value: mw_icc_ca_instance
Applicable methods: get_data
iccOperStatusNotification
Description: The operational status of the SBC has changed
Parent objects:
SbcNotifications
Value: mw_icc_ca_instance
Applicable methods: get_data
iccSigStackAlarm
Description: Notifies that activation of a signaling stack has failed
Parent objects:
SbcNotifications
Value: mw_icc_sig_stack
Applicable methods: get_data
rpsRoutingActionAlarm
Description: A routing action refers to a signaling stack that is not active
Parent objects:
SbcNotifications
Value: mw_rps_rtg_action
Applicable methods: get_data
Perl Data Object Documentation for ipsla_op_hist_oper, version 4. 2.
Objects
History
Description: Historical data for an operation
Parent objects:
Operation
Child objects:
Path - Historical data with multiple hops along the path
Target - Historical data for the destination node
Applicable methods: find_data
Target
Description: Historical data for the destination node
Parent objects:
History
Child objects:
LifeTable - Tables of lives for an operation
Applicable methods: find_data
LifeTable
Description: Tables of lives for an operation
Parent objects:
Target
Child objects:
Life - Operational data for a particular life of the operation
Applicable methods: get_keys
Life
Description: Operational data for a particular life of the operation
Parent objects:
LifeTable
Keys:
LifeIndex (mandatory)
Type: IPSLALifeIndex
Description: Life Index
Child objects:
BucketTable - Table of history buckets (samples) for a particular operation
Applicable methods: find_data
BucketTable
Description: Table of history buckets (samples) for a particular operation
Parent objects:
Life
Child objects:
Bucket - History bucket for an operation
Applicable methods: get_keys, get_entries
Bucket
Description: History bucket for an operation
Parent objects:
BucketTable
Keys:
BucketIndex (mandatory)
Type: IPSLABucketIndex
Description: Bucket Index
Value: ipsla_history_bag
Applicable methods: get_data
Datatypes
IPSLABucketIndex
Definition: xsd:unsignedInt
IPSLALifeIndex
Definition: xsd:unsignedInt
Perl Data Object Documentation for ipv4_dhcpd_oper, version 2. 2.
Objects
IPV4DHCPD
Description: IPv4 DHCPD operational data
Task IDs required: ip-services
Parent objects:
Operational
Child objects:
NodeTable - IPv4 DHCPD operational data for a particular location
Applicable methods: find_data
NodeTable
Description: IPv4 DHCPD operational data for a particular location
Parent objects:
IPV4DHCPD
Child objects:
Node - Location. For eg., 0/1/CPU0
Applicable methods: get_keys
Node
Description: Location. For eg., 0/1/CPU0
Parent objects:
NodeTable
Keys:
nodeid (mandatory)
Type: NodeID
Description: The node id to filter on. For eg., 0/1/CPU0
Child objects:
Proxy - DHCP proxy operational data
Relay - IPv4 DHCPD Relay operational data
Snoop - The DHCPD Snoop operational data
Applicable methods: find_data
Perl Data Object Documentation for alpha_display_adminoper, version 1. 1.
Objects
AlphaDisplay
Description: Alpha Display Operational data space
Task IDs required: root-system
Parent objects:
AdminOperational
Child objects:
NodeTable - Table of nodes
Applicable methods: find_data
Perl Data Object Documentation for sonet_local_interface_cfg, version 3. 1.
Objects
SONET
Description: SONET port controller configuration
Task IDs required: sonet-sdh
Parent objects:
InterfaceConfiguration
Child objects:
AuPathTable - All SDH AU Path configurations for a SONET port
ClockSource - Configure SONET port Transmit clock source
Created - none
Framing - Configure SONET port framing
LineDelayClear - none
LineDelayTrigger - none
LineHoldOffDelay - none
Loopback - Configure SONET port loopback mode
PathTable - All SONET Path configurations for a SONET port
ReportB1_BER - Configure B1 BER Threshold Crossing Alert (TCA) reporting
ReportB2_BER - Configure B2 BER Threshold Crossing Alert (TCA) reporting
ReportLAIS - Configure Line Alarm Indication Signal reporting
ReportLRDI - Configure Line Remote Defect Indication reporting
ReportSD_BER - Configure B2 BER in excess of SD threshold reporting
ReportSF_BER - Configure B2 BER in excess of SF threshold reporting
ReportSLOF - Configure Section Loss of Frame reporting
ReportSLOS - Configure Section Loss of Signal reporting
SendAISOnL2PortOnFault - Configure sending LAIS for L2Port when Pseudo-Wire fails
SendAISOnShutdown - Configure sending LAIS when shutdown
StsPathTable - All SONET Path configurations for a SONET port
ThresholdB1_BER - Configure B1 BER Threshold Crossing Alert (TCA) threshold
ThresholdB2_BER - Configure B2 BER Threshold Crossing Alert (TCA) threshold
ThresholdSD_BER - Configure Signal Degrade BER threshold
ThresholdSF_BER - Configure Signal Fail BER threshold
TransmitJ0 - Specify STS identifier (J0/C1) byte
TransmitS1S0 - Specify bits s1 and s0 of H1 byte
Applicable methods: find_data, set_data, delete_data
PathTable
Description: All SONET Path configurations for a SONET port
Parent objects:
SONET
Child objects:
Path - SONET Path configuration
Applicable methods: get_keys, set_data, delete_data
Path
Description: SONET Path configuration
Parent objects:
PathTable
Keys:
Number (mandatory)
Type: xsd:unsignedInt
Description: The SONET Path number - always 0 for non-channelized SONET ports
Child objects:
Created - none
DelayClear - none
DelayTrigger - none
HoldOffDelay - none
ReportB3_BER - Configure B3 BER Threshold Crossing Alert (TCA) reporting
ReportPAIS - Configure Path Alarm Indication Signal reporting
ReportPLOP - Configure Path Loss of Pointer reporting
ReportPRDI - Configure Path Remote Defect Indication reporting
ReportPUNEQ - Configure Path Unequipped Defect Indication reporting
Scrambling - Configure SPE scrambling
SendAISOnShutdown - Configure sending PAIS when shutdown
SendUNEQOnShutdown - Configure sending 'Unequipped' (UNEQ) when shutdown
ThresholdB3_BER - Configure B3 BER Threshold Crossing Alert (TCA) reporting
TransmitC2 - Configure STS SPE content (C2) byte
TransmitJ1 - Configure SONET path trace (J1) buffer
Applicable methods: find_data, set_data, delete_data
Created
Description: none
Parent objects:
Path
Values:
Configured (mandatory)
Type: xsd:boolean
Description: Only ever set to TRUE
Default value: none.
Applicable methods: get_data, set_data, delete_data
HoldOffDelay
Description: none
Parent objects:
Path
Values:
Delay (mandatory)
Type: Range. Value lies between 0 and 60000
Description: Defects hold OFF delay (in msec)
Default value:
Delay => 0
Applicable methods: get_data, set_data, delete_data
DelayTrigger
Description: none
Parent objects:
Path
Values:
Delay (mandatory)
Type: Range. Value lies between 0 and 60000
Description: Value of Time in milliseconds
Default value:
Delay => 0
Applicable methods: get_data, set_data, delete_data
DelayClear
Description: none
Parent objects:
Path
Values:
Delay (mandatory)
Type: Range. Value lies between 1000 and 180000
Description: Value of Time in milliseconds
Default value:
Delay => 10000
Applicable methods: get_data, set_data, delete_data
SendAISOnShutdown
Description: Configure sending PAIS when shutdown
Parent objects:
Path
Values:
Configured (mandatory)
Type: xsd:boolean
Description: Send PAIS when shutdown
Default value: none.
Applicable methods: get_data, set_data, delete_data
SendUNEQOnShutdown
Description: Configure sending 'Unequipped' (UNEQ) when shutdown
Parent objects:
Path
Values:
Configured (mandatory)
Type: xsd:boolean
Description: Send UNEQ when shutdown
Default value: none.
Applicable methods: get_data, set_data, delete_data
Scrambling
Description: Configure SPE scrambling
Parent objects:
Path
Values:
Scrambling (mandatory)
Type: SONETScramblingType
Description: SONET SPE scrambling
Default value:
Scrambling => Enabled
Applicable methods: get_data, set_data, delete_data
TransmitC2
Description: Configure STS SPE content (C2) byte
Parent objects:
Path
Values:
C2 (mandatory)
Type: Range. Value lies between 0 and 255
Description: Transmit C2 byte value
Default value:
C2 => 1
Applicable methods: get_data, set_data, delete_data
TransmitJ1
Description: Configure SONET path trace (J1) buffer
Parent objects:
Path
Values:
J1 (mandatory)
Type: xsd:string
Description: ASCII text (max 62 characters)
Default value: none.
Applicable methods: get_data, set_data, delete_data
ReportPLOP
Description: Configure Path Loss of Pointer reporting
Parent objects:
Path
Values:
Disabled (mandatory)
Type: xsd:boolean
Description: Disable PLOP reporting
Default value: none.
Applicable methods: get_data, set_data, delete_data
ReportPAIS
Description: Configure Path Alarm Indication Signal reporting
Parent objects:
Path
Values:
Configured (mandatory)
Type: xsd:boolean
Description: Enable PAIS reporting
Default value: none.
Applicable methods: get_data, set_data, delete_data
ReportPRDI
Description: Configure Path Remote Defect Indication reporting
Parent objects:
Path
Values:
Configured (mandatory)
Type: xsd:boolean
Description: Enable PRDI reporting
Default value: none.
Applicable methods: get_data, set_data, delete_data
ReportPUNEQ
Description: Configure Path Unequipped Defect Indication reporting
Parent objects:
Path
Values:
Configured (mandatory)
Type: xsd:boolean
Description: Enable PUNEQ reporting
Default value: none.
Applicable methods: get_data, set_data, delete_data
ReportB3_BER
Description: Configure B3 BER Threshold Crossing Alert (TCA) reporting
Parent objects:
Path
Values:
Disabled (mandatory)
Type: xsd:boolean
Description: Disable B3 BER TCA reporting
Default value: none.
Applicable methods: get_data, set_data, delete_data
ThresholdB3_BER
Description: Configure B3 BER Threshold Crossing Alert (TCA) reporting
Parent objects:
Path
Values:
Threshold (mandatory)
Type: Range. Value lies between 3 and 9
Description: Bit error rate (10 to the minus n)
Default value:
Threshold => 6
Applicable methods: get_data, set_data, delete_data
StsPathTable
Description: All SONET Path configurations for a SONET port
Parent objects:
SONET
Child objects:
StsPath - SONET STS Path configuration
Applicable methods: get_keys, set_data, delete_data
StsPath
Description: SONET STS Path configuration
Parent objects:
StsPathTable
Keys:
Number (mandatory)
Type: xsd:unsignedInt
Description: Valid range for path is 1-48
Child objects:
DelayClear - none
DelayTrigger - none
ReportB3_BER - Configure B3 BER Threshold Crossing Alert (TCA) reporting
ReportPAIS - Configure Path Alarm Indication Signal reporting
ReportPLOP - Configure Path Loss of Pointer reporting
ReportPRDI - Configure Path Remote Defect Indication reporting
ReportPUNEQ - Configure Path Unequipped Defect Indication reporting
Service - Configure service on sts Path
ThresholdB3_BER - Configure B3 BER Threshold Crossing Alert (TCA) reporting
TransmitC2 - Configure STS SPE content (C2) byte
TransmitJ1 - Configure SONET path trace (J1) buffer
Width - Configure width on sts Path
Applicable methods: find_data, set_data, delete_data
TransmitC2
Description: Configure STS SPE content (C2) byte
Parent objects:
StsPath
Values:
C2 (mandatory)
Type: Range. Value lies between 0 and 255
Description: Transmit C2 byte value
Default value:
C2 => 1
Applicable methods: get_data, set_data, delete_data
TransmitJ1
Description: Configure SONET path trace (J1) buffer
Parent objects:
StsPath
Values:
J1 (mandatory)
Type: xsd:string
Description: ASCII text (max 62 characters)
Default value: none.
Applicable methods: get_data, set_data, delete_data
ReportPLOP
Description: Configure Path Loss of Pointer reporting
Parent objects:
StsPath
Values:
Disabled (mandatory)
Type: xsd:boolean
Description: Disable PLOP reporting
Default value: none.
Applicable methods: get_data, set_data, delete_data
ReportPAIS
Description: Configure Path Alarm Indication Signal reporting
Parent objects:
StsPath
Values:
Configured (mandatory)
Type: xsd:boolean
Description: Enable PAIS reporting
Default value: none.
Applicable methods: get_data, set_data, delete_data
ReportPRDI
Description: Configure Path Remote Defect Indication reporting
Parent objects:
StsPath
Values:
Configured (mandatory)
Type: xsd:boolean
Description: Enable PRDI reporting
Default value: none.
Applicable methods: get_data, set_data, delete_data
ReportPUNEQ
Description: Configure Path Unequipped Defect Indication reporting
Parent objects:
StsPath
Values:
Configured (mandatory)
Type: xsd:boolean
Description: Enable PUNEQ reporting
Default value: none.
Applicable methods: get_data, set_data, delete_data
ReportB3_BER
Description: Configure B3 BER Threshold Crossing Alert (TCA) reporting
Parent objects:
StsPath
Values:
Disabled (mandatory)
Type: xsd:boolean
Description: Disable B3 BER TCA reporting
Default value: none.
Applicable methods: get_data, set_data, delete_data
ThresholdB3_BER
Description: Configure B3 BER Threshold Crossing Alert (TCA) reporting
Parent objects:
StsPath
Values:
Threshold (mandatory)
Type: Range. Value lies between 3 and 9
Description: Bit error rate (10 to the minus n)
Default value:
Threshold => 6
Applicable methods: get_data, set_data, delete_data
Width
Description: Configure width on sts Path
Parent objects:
StsPath
Values:
Width (mandatory)
Type: Range. Value lies between 1 and 768
Description: Valid width(1,3,12,48..), natural sts boundaries(1,4,7,10,13..)
Default value: none.
Applicable methods: get_data, set_data, delete_data
Service
Description: Configure service on sts Path
Parent objects:
StsPath
Values:
Service (mandatory)
Type: STSServiceType
Description: STS path service type
Default value: none.
Applicable methods: get_data, set_data, delete_data
DelayTrigger
Description: none
Parent objects:
StsPath
Values:
Delay (mandatory)
Type: Range. Value lies between 0 and 60000
Description: Value of Time in milliseconds
Default value:
Delay => 0
Applicable methods: get_data, set_data, delete_data
DelayClear
Description: none
Parent objects:
StsPath
Values:
Delay (mandatory)
Type: Range. Value lies between 1000 and 180000
Description: Value of Time in milliseconds
Default value:
Delay => 10000
Applicable methods: get_data, set_data, delete_data
AuPathTable
Description: All SDH AU Path configurations for a SONET port
Parent objects:
SONET
Child objects:
AuPath - SDH AU Path configuration
Applicable methods: get_keys, set_data, delete_data
AuPath
Description: SDH AU Path configuration
Parent objects:
AuPathTable
Keys:
Number (mandatory)
Type: xsd:unsignedInt
Description: Valid range for path is 1-48
Child objects:
DelayClear - none
DelayTrigger - none
ReportB3_BER - Configure B3 BER Threshold Crossing Alert (TCA) reporting
ReportPAIS - Configure Path Alarm Indication Signal reporting
ReportPLOP - Configure Path Loss of Pointer reporting
ReportPRDI - Configure Path Remote Defect Indication reporting
ReportPUNEQ - Configure Path Unequipped Defect Indication reporting
Service - Configure service on au Path
ThresholdB3_BER - Configure B3 BER Threshold Crossing Alert (TCA) reporting
TransmitC2 - Configure STS SPE content (C2) byte
TransmitJ1 - Configure SONET path trace (J1) buffer
Tug3PathTable - All tug3 Path configurations for a SONET port
Width - Configure width on sts Path
Applicable methods: find_data, set_data, delete_data
Tug3PathTable
Description: All tug3 Path configurations for a SONET port
Parent objects:
AuPath
Child objects:
Tug3Path - SDH tug3 Path configuration
Applicable methods: get_keys, set_data, delete_data
Tug3Path
Description: SDH tug3 Path configuration
Parent objects:
Tug3PathTable
Keys:
Number (mandatory)
Type: xsd:unsignedInt
Description: Valid range for path is 1-3
Child objects:
Service - Configure service on tug3 Path
Applicable methods: find_data, set_data, delete_data
Service
Description: Configure service on tug3 Path
Parent objects:
Tug3Path
Values:
Mode (mandatory)
Type: TUG3ServiceType
Description: TUG3 path service type
Default value: none.
Applicable methods: get_data, set_data, delete_data
TransmitC2
Description: Configure STS SPE content (C2) byte
Parent objects:
AuPath
Values:
C2 (mandatory)
Type: Range. Value lies between 0 and 255
Description: Transmit C2 byte value
Default value:
C2 => 1
Applicable methods: get_data, set_data, delete_data
TransmitJ1
Description: Configure SONET path trace (J1) buffer
Parent objects:
AuPath
Values:
J1 (mandatory)
Type: xsd:string
Description: ASCII text (max 62 characters)
Default value: none.
Applicable methods: get_data, set_data, delete_data
ReportPLOP
Description: Configure Path Loss of Pointer reporting
Parent objects:
AuPath
Values:
Disabled (mandatory)
Type: xsd:boolean
Description: Disable PLOP reporting
Default value: none.
Applicable methods: get_data, set_data, delete_data
ReportPAIS
Description: Configure Path Alarm Indication Signal reporting
Parent objects:
AuPath
Values:
Configured (mandatory)
Type: xsd:boolean
Description: Enable PAIS reporting
Default value: none.
Applicable methods: get_data, set_data, delete_data
ReportPRDI
Description: Configure Path Remote Defect Indication reporting
Parent objects:
AuPath
Values:
Configured (mandatory)
Type: xsd:boolean
Description: Enable PRDI reporting
Default value: none.
Applicable methods: get_data, set_data, delete_data
ReportPUNEQ
Description: Configure Path Unequipped Defect Indication reporting
Parent objects:
AuPath
Values:
Configured (mandatory)
Type: xsd:boolean
Description: Enable PUNEQ reporting
Default value: none.
Applicable methods: get_data, set_data, delete_data
ReportB3_BER
Description: Configure B3 BER Threshold Crossing Alert (TCA) reporting
Parent objects:
AuPath
Values:
Disabled (mandatory)
Type: xsd:boolean
Description: Disable B3 BER TCA reporting
Default value: none.
Applicable methods: get_data, set_data, delete_data
ThresholdB3_BER
Description: Configure B3 BER Threshold Crossing Alert (TCA) reporting
Parent objects:
AuPath
Values:
Threshold (mandatory)
Type: Range. Value lies between 3 and 9
Description: Bit error rate (10 to the minus n)
Default value:
Threshold => 6
Applicable methods: get_data, set_data, delete_data
Width
Description: Configure width on sts Path
Parent objects:
AuPath
Values:
Width (mandatory)
Type: Range. Value lies between 1 and 768
Description: Valid width(1,3,12,48..), natural au boundaries(1,4,7,10,13..)
Default value: none.
Applicable methods: get_data, set_data, delete_data
Service
Description: Configure service on au Path
Parent objects:
AuPath
Values:
Service (mandatory)
Type: AUServiceType
Description: AU path service type
Default value: none.
Applicable methods: get_data, set_data, delete_data
DelayTrigger
Description: none
Parent objects:
AuPath
Values:
Delay (mandatory)
Type: Range. Value lies between 0 and 60000
Description: Value of Time in milliseconds
Default value:
Delay => 0
Applicable methods: get_data, set_data, delete_data
DelayClear
Description: none
Parent objects:
AuPath
Values:
Delay (mandatory)
Type: Range. Value lies between 1000 and 180000
Description: Value of Time in milliseconds
Default value:
Delay => 10000
Applicable methods: get_data, set_data, delete_data
Created
Description: none
Parent objects:
SONET
Values:
Configured (mandatory)
Type: xsd:boolean
Description: Only ever set to TRUE
Default value: none.
Applicable methods: get_data, set_data, delete_data
LineHoldOffDelay
Description: none
Parent objects:
SONET
Values:
Delay (mandatory)
Type: Range. Value lies between 0 and 60000
Description: Line defects hold OFF delay (in msec)
Default value:
Delay => 0
Applicable methods: get_data, set_data, delete_data
LineDelayTrigger
Description: none
Parent objects:
SONET
Values:
Delay (mandatory)
Type: Range. Value lies between 0 and 60000
Description: Value of Time in milliseconds
Default value:
Delay => 0
Applicable methods: get_data, set_data, delete_data
LineDelayClear
Description: none
Parent objects:
SONET
Values:
Delay (mandatory)
Type: Range. Value lies between 1000 and 180000
Description: Value of Time in milliseconds
Default value:
Delay => 10000
Applicable methods: get_data, set_data, delete_data
SendAISOnShutdown
Description: Configure sending LAIS when shutdown
Parent objects:
SONET
Values:
Configured (mandatory)
Type: xsd:boolean
Description: Send LAIS when shutdown
Default value: none.
Applicable methods: get_data, set_data, delete_data
SendAISOnL2PortOnFault
Description: Configure sending LAIS for L2Port when Pseudo-Wire fails
Parent objects:
SONET
Values:
Configured (mandatory)
Type: xsd:boolean
Description: Send LAIS for L2Port when Pseudo-Wire fails
Default value: none.
Applicable methods: get_data, set_data, delete_data
ClockSource
Description: Configure SONET port Transmit clock source
Parent objects:
SONET
Values:
ClockSource (mandatory)
Type: SONETClockSourceType
Description: SONET Transmit Clock Source
Default value:
ClockSource => Line
Applicable methods: get_data, set_data, delete_data
Framing
Description: Configure SONET port framing
Parent objects:
SONET
Values:
Framing (mandatory)
Type: SONETFramingType
Description: SONET port framing
Default value:
Framing => SONET
Applicable methods: get_data, set_data, delete_data
Loopback
Description: Configure SONET port loopback mode
Parent objects:
SONET
Values:
Loopback (mandatory)
Type: xsd:string
Description: SONET port loopback mode:internal,line
Default value: none.
Applicable methods: get_data, set_data, delete_data
TransmitJ0
Description: Specify STS identifier (J0/C1) byte
Parent objects:
SONET
Values:
J0 (mandatory)
Type: Range. Value lies between 0 and 255
Description: Transmit J0/C1 byte value
Default value:
J0 => 1
Applicable methods: get_data, set_data, delete_data
TransmitS1S0
Description: Specify bits s1 and s0 of H1 byte
Parent objects:
SONET
Values:
s1s0 (mandatory)
Type: Range. Value lies between 0 and 3
Description: Transmit s1 & s0 bits value
Default value:
s1s0 => 0
Applicable methods: get_data, set_data, delete_data
ReportSLOS
Description: Configure Section Loss of Signal reporting
Parent objects:
SONET
Values:
Disabled (mandatory)
Type: xsd:boolean
Description: Disable SLOS reporting
Default value: none.
Applicable methods: get_data, set_data, delete_data
ReportSLOF
Description: Configure Section Loss of Frame reporting
Parent objects:
SONET
Values:
Disabled (mandatory)
Type: xsd:boolean
Description: Disable SLOF reporting
Default value: none.
Applicable methods: get_data, set_data, delete_data
ReportLAIS
Description: Configure Line Alarm Indication Signal reporting
Parent objects:
SONET
Values:
Configured (mandatory)
Type: xsd:boolean
Description: Enable LAIS reporting
Default value: none.
Applicable methods: get_data, set_data, delete_data
ReportLRDI
Description: Configure Line Remote Defect Indication reporting
Parent objects:
SONET
Values:
Configured (mandatory)
Type: xsd:boolean
Description: Enable LRDI reporting
Default value: none.
Applicable methods: get_data, set_data, delete_data
ReportB1_BER
Description: Configure B1 BER Threshold Crossing Alert (TCA) reporting
Parent objects:
SONET
Values:
Disabled (mandatory)
Type: xsd:boolean
Description: Disable B1 BER TCA reporting
Default value: none.
Applicable methods: get_data, set_data, delete_data
ReportB2_BER
Description: Configure B2 BER Threshold Crossing Alert (TCA) reporting
Parent objects:
SONET
Values:
Disabled (mandatory)
Type: xsd:boolean
Description: Disable B2 BER TCA reporting
Default value: none.
Applicable methods: get_data, 