Documentation ¶
Overview ¶
This module contains a collection of YANG definitions for Cisco IOS-XR Subscriber-infra-subdb package operational data.
This module contains definitions for the following management objects:
subscriber-database: Subscriber database operational data
Copyright (c) 2013-2018 by Cisco Systems, Inc. All rights reserved.
Index ¶
- type SessionState
- type SubdbObjectTypeData
- type SubscriberDatabase
- type SubscriberDatabase_Nodes
- type SubscriberDatabase_Nodes_Node
- type SubscriberDatabase_Nodes_Node_Association
- type SubscriberDatabase_Nodes_Node_Association_Labels
- type SubscriberDatabase_Nodes_Node_Association_Labels_Label
- type SubscriberDatabase_Nodes_Node_Association_Labels_Label_Template
- type SubscriberDatabase_Nodes_Node_Association_Labels_Label_Template_AssociatedTemplate
- type SubscriberDatabase_Nodes_Node_Session
- type SubscriberDatabase_Nodes_Node_Session_Labels
- type SubscriberDatabase_Nodes_Node_Session_Labels_Label
- type SubscriberDatabase_Nodes_Node_Summary
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type SessionState ¶
type SessionState string
SessionState represents Session states
const ( // Initialisation SessionState_init SessionState = "init" // Destroy SessionState_destroy SessionState = "destroy" // Config generate SessionState_config_generate SessionState = "config-generate" // Feature registration wait SessionState_feature_registration_wait SessionState = "feature-registration-wait" // Config apply SessionState_config_apply SessionState = "config-apply" // Config done SessionState_config_done SessionState = "config-done" // Config removed SessionState_config_removed SessionState = "config-removed" // Config error SessionState_config_error SessionState = "config-error" // Error SessionState_error_ SessionState = "error" // Sync SessionState_sync SessionState = "sync" )
type SubdbObjectTypeData ¶
type SubdbObjectTypeData string
SubdbObjectTypeData represents Template types
const ( // User profile SubdbObjectTypeData_user_profile SubdbObjectTypeData = "user-profile" // Service profile SubdbObjectTypeData_service_profile SubdbObjectTypeData = "service-profile" // Subscriber service template SubdbObjectTypeData_subscriber_service SubdbObjectTypeData = "subscriber-service" // PPP template SubdbObjectTypeData_ppp SubdbObjectTypeData = "ppp" // IP subscriber template SubdbObjectTypeData_ip_subscriber SubdbObjectTypeData = "ip-subscriber" )
type SubscriberDatabase ¶
type SubscriberDatabase struct { EntityData types.CommonEntityData YFilter yfilter.YFilter // List of nodes for which subscriber data is collected. Nodes SubscriberDatabase_Nodes }
SubscriberDatabase Subscriber database operational data
func (*SubscriberDatabase) GetEntityData ¶
func (subscriberDatabase *SubscriberDatabase) GetEntityData() *types.CommonEntityData
type SubscriberDatabase_Nodes ¶
type SubscriberDatabase_Nodes struct { EntityData types.CommonEntityData YFilter yfilter.YFilter // Subscriber data for a particular node. The type is slice of // SubscriberDatabase_Nodes_Node. Node []*SubscriberDatabase_Nodes_Node }
SubscriberDatabase_Nodes List of nodes for which subscriber data is collected
func (*SubscriberDatabase_Nodes) GetEntityData ¶
func (nodes *SubscriberDatabase_Nodes) GetEntityData() *types.CommonEntityData
type SubscriberDatabase_Nodes_Node ¶
type SubscriberDatabase_Nodes_Node struct { EntityData types.CommonEntityData YFilter yfilter.YFilter YListKey string // This attribute is a key. Node name. The type is string with pattern: // ([a-zA-Z0-9_]*\d+/){1,2}([a-zA-Z0-9_]*\d+). NodeName interface{} // Subscriber data for associated templates. Association SubscriberDatabase_Nodes_Node_Association // Subscriber data for associated templates. Summary SubscriberDatabase_Nodes_Node_Summary // Subscriber management session information. Session SubscriberDatabase_Nodes_Node_Session }
SubscriberDatabase_Nodes_Node Subscriber data for a particular node
func (*SubscriberDatabase_Nodes_Node) GetEntityData ¶
func (node *SubscriberDatabase_Nodes_Node) GetEntityData() *types.CommonEntityData
type SubscriberDatabase_Nodes_Node_Association ¶
type SubscriberDatabase_Nodes_Node_Association struct { EntityData types.CommonEntityData YFilter yfilter.YFilter // List of associated subscriber labels. Labels SubscriberDatabase_Nodes_Node_Association_Labels }
SubscriberDatabase_Nodes_Node_Association Subscriber data for associated templates
func (*SubscriberDatabase_Nodes_Node_Association) GetEntityData ¶
func (association *SubscriberDatabase_Nodes_Node_Association) GetEntityData() *types.CommonEntityData
type SubscriberDatabase_Nodes_Node_Association_Labels ¶
type SubscriberDatabase_Nodes_Node_Association_Labels struct { EntityData types.CommonEntityData YFilter yfilter.YFilter // Association for a given subscriber label. The type is slice of // SubscriberDatabase_Nodes_Node_Association_Labels_Label. Label []*SubscriberDatabase_Nodes_Node_Association_Labels_Label }
SubscriberDatabase_Nodes_Node_Association_Labels List of associated subscriber labels
func (*SubscriberDatabase_Nodes_Node_Association_Labels) GetEntityData ¶
func (labels *SubscriberDatabase_Nodes_Node_Association_Labels) GetEntityData() *types.CommonEntityData
type SubscriberDatabase_Nodes_Node_Association_Labels_Label ¶
type SubscriberDatabase_Nodes_Node_Association_Labels_Label struct { EntityData types.CommonEntityData YFilter yfilter.YFilter YListKey string // This attribute is a key. Subscriber label. The type is string with pattern: // [0-9a-fA-F]{1,8}. SubscriberLabel interface{} // Interface name. The type is string with pattern: [a-zA-Z0-9._/-]+. InterfaceName interface{} // Association count which reflects number of entries in AssociatedTemplates. // The type is interface{} with range: 0..4294967295. Associations interface{} // Varlist Id. The type is interface{} with range: 0..4294967295. VarlistId interface{} // Subdb template. Template SubscriberDatabase_Nodes_Node_Association_Labels_Label_Template }
SubscriberDatabase_Nodes_Node_Association_Labels_Label Association for a given subscriber label
func (*SubscriberDatabase_Nodes_Node_Association_Labels_Label) GetEntityData ¶
func (label *SubscriberDatabase_Nodes_Node_Association_Labels_Label) GetEntityData() *types.CommonEntityData
type SubscriberDatabase_Nodes_Node_Association_Labels_Label_Template ¶
type SubscriberDatabase_Nodes_Node_Association_Labels_Label_Template struct { EntityData types.CommonEntityData YFilter yfilter.YFilter // Associated templates. The type is slice of // SubscriberDatabase_Nodes_Node_Association_Labels_Label_Template_AssociatedTemplate. AssociatedTemplate []*SubscriberDatabase_Nodes_Node_Association_Labels_Label_Template_AssociatedTemplate }
SubscriberDatabase_Nodes_Node_Association_Labels_Label_Template Subdb template
func (*SubscriberDatabase_Nodes_Node_Association_Labels_Label_Template) GetEntityData ¶
func (template *SubscriberDatabase_Nodes_Node_Association_Labels_Label_Template) GetEntityData() *types.CommonEntityData
type SubscriberDatabase_Nodes_Node_Association_Labels_Label_Template_AssociatedTemplate ¶
type SubscriberDatabase_Nodes_Node_Association_Labels_Label_Template_AssociatedTemplate struct { EntityData types.CommonEntityData YFilter yfilter.YFilter YListKey string // Template type. The type is SubdbObjectTypeData. TemplateType interface{} // Template name. The type is string with length: 0..65. TemplateName interface{} // Varlist. The type is string with length: 0..1000. Varlist interface{} }
SubscriberDatabase_Nodes_Node_Association_Labels_Label_Template_AssociatedTemplate Associated templates
func (*SubscriberDatabase_Nodes_Node_Association_Labels_Label_Template_AssociatedTemplate) GetEntityData ¶
func (associatedTemplate *SubscriberDatabase_Nodes_Node_Association_Labels_Label_Template_AssociatedTemplate) GetEntityData() *types.CommonEntityData
type SubscriberDatabase_Nodes_Node_Session ¶
type SubscriberDatabase_Nodes_Node_Session struct { EntityData types.CommonEntityData YFilter yfilter.YFilter // Subscriber management list of subscriber labels. Labels SubscriberDatabase_Nodes_Node_Session_Labels }
SubscriberDatabase_Nodes_Node_Session Subscriber management session information
func (*SubscriberDatabase_Nodes_Node_Session) GetEntityData ¶
func (session *SubscriberDatabase_Nodes_Node_Session) GetEntityData() *types.CommonEntityData
type SubscriberDatabase_Nodes_Node_Session_Labels ¶
type SubscriberDatabase_Nodes_Node_Session_Labels struct { EntityData types.CommonEntityData YFilter yfilter.YFilter // Session information for a subscriber label. The type is slice of // SubscriberDatabase_Nodes_Node_Session_Labels_Label. Label []*SubscriberDatabase_Nodes_Node_Session_Labels_Label }
SubscriberDatabase_Nodes_Node_Session_Labels Subscriber management list of subscriber labels
func (*SubscriberDatabase_Nodes_Node_Session_Labels) GetEntityData ¶
func (labels *SubscriberDatabase_Nodes_Node_Session_Labels) GetEntityData() *types.CommonEntityData
type SubscriberDatabase_Nodes_Node_Session_Labels_Label ¶
type SubscriberDatabase_Nodes_Node_Session_Labels_Label struct { EntityData types.CommonEntityData YFilter yfilter.YFilter YListKey string // This attribute is a key. Subscriber label. The type is string with pattern: // [0-9a-fA-F]{1,8}. SubscriberLabel interface{} // Subscriber session state. The type is SessionState. SessionState interface{} // Activate request identifier. The type is interface{} with range: // 0..4294967295. ActivateRequestId interface{} // Transaction identifier associated with a particular 'produce_done' or // 'produce_all_done' request default value is 0xffffffff which represents // 'None'. The type is interface{} with range: -2147483648..2147483647. TransactionId interface{} // Produce done request ID. The type is interface{} with range: 0..4294967295. ProduceDoneRequestId interface{} // Flags indicating if a destroy request is received. The type is bool. DestroyReqReceived interface{} // Destroy request ID. The type is interface{} with range: 0..4294967295. DestroyRequestId interface{} // Is true if configuration change due to template change only and not due to // a produce done request. The type is bool. IsConfigChanged interface{} // Is true if the creator of the connection is destroyed. The type is bool. IsCreatorGone interface{} // Is true if the deleted features have all been notified and all 'apply done' // ack messages have been received. The type is bool. IsDeleteNotifyDone interface{} // Is true if added/modified features have all been notified and all 'apply // done' ack messages have been received. The type is bool. AddModifyDone interface{} // Is true if the subscriber should be rolled back to the configuration prior // to this transaction when all the outstanding backend programming interface // requests are replied. The type is bool. IsRollbackNeeded interface{} // Is true if subscriber's configuration is being rolled back. The type is // bool. IsRollbackInProgress interface{} // Is true if the subscriber's configuration is being applied due to // subscriber database server restart. The type is bool. IsServerRestartApply interface{} // Is true if rollback has previously been performed for this subscriber. The // type is bool. IsRollbackPerformed interface{} // Flags indicating if there is pending replication. The type is bool. ReplPending interface{} // Flags indicating if activate timer is running. The type is bool. ActivateTimerRunning interface{} // Flags indicating if apply timer is running. The type is bool. ApplyTimerRunning interface{} // the current size of the event queue. The type is bool. EventQueueSize interface{} // Restart vector to keep track of the restart state. The type is string with // pattern: ([0-9a-fA-F]{2}(:[0-9a-fA-F]{2})*)?. Restarts interface{} // Template Interface Identifier. The type is interface{} with range: // 0..4294967295. TemplateInterfaceId interface{} }
SubscriberDatabase_Nodes_Node_Session_Labels_Label Session information for a subscriber label
func (*SubscriberDatabase_Nodes_Node_Session_Labels_Label) GetEntityData ¶
func (label *SubscriberDatabase_Nodes_Node_Session_Labels_Label) GetEntityData() *types.CommonEntityData
type SubscriberDatabase_Nodes_Node_Summary ¶
type SubscriberDatabase_Nodes_Node_Summary struct { EntityData types.CommonEntityData YFilter yfilter.YFilter // Number of Entries in Association DB. The type is interface{} with range: // 0..4294967295. AssocDbEntries interface{} // Number of Associations in Association DB. The type is interface{} with // range: 0..4294967295. AssocDbAssociations interface{} // Number of Entries in Derived DB. The type is interface{} with range: // 0..4294967295. DerivedDbEntries interface{} // Number of Entries in Configuration DB. The type is interface{} with range: // 0..4294967295. ConfigDbEntries interface{} // Number of Entries in Interface DB. The type is interface{} with range: // 0..4294967295. InterfaceDbEntries interface{} // Number of IPSUB DHCP subscribers. The type is interface{} with range: // 0..4294967295. NumIpsubDhcp interface{} // Number of IPSUB Inband subscribers. The type is interface{} with range: // 0..4294967295. NumIpsubInband interface{} // Number of PPPOE subscribers. The type is interface{} with range: // 0..4294967295. NumPppoe interface{} // The count of the various configuration objects by type. The type is slice // of interface{} with range: 0..4294967295. SubdbObjCountsByType []interface{} // Number of subscribers in the various states. The type is slice of // interface{} with range: 0..4294967295. NumSubscribersInState []interface{} // Cumulative number of transitions through the various states. The type is // slice of interface{} with range: 0..4294967295. NumTransitionsThroughState []interface{} }
SubscriberDatabase_Nodes_Node_Summary Subscriber data for associated templates
func (*SubscriberDatabase_Nodes_Node_Summary) GetEntityData ¶
func (summary *SubscriberDatabase_Nodes_Node_Summary) GetEntityData() *types.CommonEntityData