Documentation ¶
Overview ¶
This module contains a collection of YANG definitions for DHCP Server and Client operational data. Copyright (c) 2017-2018 by Cisco Systems, Inc. All rights reserved.
Index ¶
- type DhcpClientIdType
- type DhcpClientState
- type DhcpExpiryOption
- type DhcpOperData
- type DhcpOperData_Dhcpv4ClientOper
- type DhcpOperData_Dhcpv4ClientOper_LeaseExpiry
- type DhcpOperData_Dhcpv4ServerOper
- type DhcpOperData_Dhcpv4ServerOper_Expiration
- type DhcpServerBindingState
- type DhcpServerBindingType
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type DhcpClientIdType ¶
type DhcpClientIdType string
DhcpClientIdType represents DHCP Client id hardware types
const ( // DHCP Client hardware type Ethernet DhcpClientIdType_dhcp_htype_ethernet DhcpClientIdType = "dhcp-htype-ethernet" // DHCP Client hardware type 802 DhcpClientIdType_dhcp_htype_ieee802 DhcpClientIdType = "dhcp-htype-ieee802" // DHCP Client hardware type RFCLIMIT DhcpClientIdType_dhcp_htype_rfclimit DhcpClientIdType = "dhcp-htype-rfclimit" // DHCP Client hardware type CLIENTID DhcpClientIdType_dhcp_htype_clientid DhcpClientIdType = "dhcp-htype-clientid" )
type DhcpClientState ¶
type DhcpClientState string
DhcpClientState represents DHCP Client state
const ( // Client state address/sync from other client DhcpClientState_dhcp_client_state_temp_from_client DhcpClientState = "dhcp-client-state-temp-from-client" // Client state Sync DhcpClientState_dhcp_client_state_temp_from_sync DhcpClientState = "dhcp-client-state-temp-from-sync" // Client state Initialing DhcpClientState_dhcp_client_state_initial DhcpClientState = "dhcp-client-state-initial" // Client state Selecting DhcpClientState_dhcp_client_state_selecting DhcpClientState = "dhcp-client-state-selecting" // Client state Requesting DhcpClientState_dhcp_client_state_requesting DhcpClientState = "dhcp-client-state-requesting" // Client state bound DhcpClientState_dhcp_client_state_bound DhcpClientState = "dhcp-client-state-bound" // Client state rebinding DhcpClientState_dhcp_client_state_rebinding DhcpClientState = "dhcp-client-state-rebinding" // Client state renewing DhcpClientState_dhcp_client_state_renewing DhcpClientState = "dhcp-client-state-renewing" // Client state holdtime DhcpClientState_dhcp_client_state_holdtime DhcpClientState = "dhcp-client-state-holdtime" // Client state DDNS wait DhcpClientState_dhcp_client_state_ddns_wait DhcpClientState = "dhcp-client-state-ddns-wait" // Client state releasing DhcpClientState_dhcp_client_state_releasing DhcpClientState = "dhcp-client-state-releasing" // Client state purging DhcpClientState_dhcp_client_state_purging DhcpClientState = "dhcp-client-state-purging" // Client state leasequery DhcpClientState_dhcp_client_state_leasequery DhcpClientState = "dhcp-client-state-leasequery" // Client state unknown DhcpClientState_dhcp_client_state_unknown DhcpClientState = "dhcp-client-state-unknown" )
type DhcpExpiryOption ¶
type DhcpExpiryOption string
DhcpExpiryOption represents DHCP expiration option
const ( // Expiration option time DhcpExpiryOption_dhcp_expiration_time DhcpExpiryOption = "dhcp-expiration-time" // Expiration option infinite DhcpExpiryOption_dhcp_expiration_infinite DhcpExpiryOption = "dhcp-expiration-infinite" )
type DhcpOperData ¶
type DhcpOperData struct { EntityData types.CommonEntityData YFilter yfilter.YFilter // List of DHCP server bidning. The type is slice of // DhcpOperData_Dhcpv4ServerOper. Dhcpv4ServerOper []*DhcpOperData_Dhcpv4ServerOper // List of DHCP clients. The type is slice of DhcpOperData_Dhcpv4ClientOper. Dhcpv4ClientOper []*DhcpOperData_Dhcpv4ClientOper }
DhcpOperData Operational state of DHCP
func (*DhcpOperData) GetEntityData ¶
func (dhcpOperData *DhcpOperData) GetEntityData() *types.CommonEntityData
type DhcpOperData_Dhcpv4ClientOper ¶
type DhcpOperData_Dhcpv4ClientOper struct { EntityData types.CommonEntityData YFilter yfilter.YFilter YListKey string // This attribute is a key. Interface infomation where dhcp Client is // configured. The type is string. IfName interface{} // This attribute is a key. Client_addr address Allocated from Server. The // type is one of the following types: string with pattern: // (([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\p{N}\p{L}]+)?, // or string with pattern: // ((:|[0-9a-fA-F]{0,4}):)([0-9a-fA-F]{0,4}:){0,5}((([0-9a-fA-F]{0,4}:)?(:|[0-9a-fA-F]{0,4}))|(((25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])))(%[\p{N}\p{L}]+)?. ClientAddr interface{} // This attribute is a key. Vrfname infomation related to Client. The type is // string. VrfName interface{} // DHCP Client States . The type is DhcpClientState. State interface{} // IP address of Server from where we got IP. The type is one of the following // types: string with pattern: // (([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\p{N}\p{L}]+)?, // or string with pattern: // ((:|[0-9a-fA-F]{0,4}):)([0-9a-fA-F]{0,4}:){0,5}((([0-9a-fA-F]{0,4}:)?(:|[0-9a-fA-F]{0,4}))|(((25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])))(%[\p{N}\p{L}]+)?. LeaseServerAddr interface{} // Gateway Address we got from Server. The type is one of the following types: // string with pattern: // (([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\p{N}\p{L}]+)?, // or string with pattern: // ((:|[0-9a-fA-F]{0,4}):)([0-9a-fA-F]{0,4}:){0,5}((([0-9a-fA-F]{0,4}:)?(:|[0-9a-fA-F]{0,4}))|(((25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])))(%[\p{N}\p{L}]+)?. GatewayAddr interface{} // Total Lease Time in Seconds. The type is interface{} with range: // 0..4294967295. LeaseTime interface{} // Lease remaining time for the IP address. The type is interface{} with // range: 0..4294967295. LeaseRemaining interface{} // First DNS address. The type is one of the following types: string with // pattern: // (([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\p{N}\p{L}]+)?, // or string with pattern: // ((:|[0-9a-fA-F]{0,4}):)([0-9a-fA-F]{0,4}:){0,5}((([0-9a-fA-F]{0,4}:)?(:|[0-9a-fA-F]{0,4}))|(((25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])))(%[\p{N}\p{L}]+)?. DnsAddress interface{} // Secondary DNS address. The type is one of the following types: string with // pattern: // (([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\p{N}\p{L}]+)?, // or string with pattern: // ((:|[0-9a-fA-F]{0,4}):)([0-9a-fA-F]{0,4}:){0,5}((([0-9a-fA-F]{0,4}:)?(:|[0-9a-fA-F]{0,4}))|(((25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])))(%[\p{N}\p{L}]+)?. DnsAddressSecondary interface{} // Subnet mask address. The type is one of the following types: string with // pattern: // (([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\p{N}\p{L}]+)?, // or string with pattern: // ((:|[0-9a-fA-F]{0,4}):)([0-9a-fA-F]{0,4}:){0,5}((([0-9a-fA-F]{0,4}:)?(:|[0-9a-fA-F]{0,4}))|(((25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])))(%[\p{N}\p{L}]+)?. SubnetMask interface{} // Lease Expiry time for the IP address we got. LeaseExpiry DhcpOperData_Dhcpv4ClientOper_LeaseExpiry }
DhcpOperData_Dhcpv4ClientOper List of DHCP clients
func (*DhcpOperData_Dhcpv4ClientOper) GetEntityData ¶
func (dhcpv4ClientOper *DhcpOperData_Dhcpv4ClientOper) GetEntityData() *types.CommonEntityData
type DhcpOperData_Dhcpv4ClientOper_LeaseExpiry ¶
type DhcpOperData_Dhcpv4ClientOper_LeaseExpiry struct { EntityData types.CommonEntityData YFilter yfilter.YFilter // Date and time of expiry . The type is string with pattern: // \d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[\+\-]\d{2}:\d{2}). Time interface{} // Expiry time infinite. The type is interface{}. Infinite interface{} }
DhcpOperData_Dhcpv4ClientOper_LeaseExpiry Lease Expiry time for the IP address we got
func (*DhcpOperData_Dhcpv4ClientOper_LeaseExpiry) GetEntityData ¶
func (leaseExpiry *DhcpOperData_Dhcpv4ClientOper_LeaseExpiry) GetEntityData() *types.CommonEntityData
type DhcpOperData_Dhcpv4ServerOper ¶
type DhcpOperData_Dhcpv4ServerOper struct { EntityData types.CommonEntityData YFilter yfilter.YFilter YListKey string // This attribute is a key. Server Pool name from where the Client ip is // provided. The type is string. PoolName interface{} // This attribute is a key. ipaddress released for a speicfic Client from // Server. The type is one of the following types: string with pattern: // (([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\p{N}\p{L}]+)?, // or string with pattern: // ((:|[0-9a-fA-F]{0,4}):)([0-9a-fA-F]{0,4}:){0,5}((([0-9a-fA-F]{0,4}:)?(:|[0-9a-fA-F]{0,4}))|(((25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])))(%[\p{N}\p{L}]+)?. ClientIp interface{} // This attribute is a key. Query based on the vrfname speicfic to that pool // and Client ip address as key. The type is string. VrfName interface{} // Client identification Hardware types. The type is DhcpClientIdType. ClientIdType interface{} // Client identification can be based on Hardware types/Mac. The type is // string. ClientId interface{} // Server binding type. The type is DhcpServerBindingType. Type interface{} // Server binding states. The type is DhcpServerBindingState. State interface{} // interface name of the pool. The type is string. Interface interface{} // Expiration time infomation. Expiration DhcpOperData_Dhcpv4ServerOper_Expiration }
DhcpOperData_Dhcpv4ServerOper List of DHCP server bidning
func (*DhcpOperData_Dhcpv4ServerOper) GetEntityData ¶
func (dhcpv4ServerOper *DhcpOperData_Dhcpv4ServerOper) GetEntityData() *types.CommonEntityData
type DhcpOperData_Dhcpv4ServerOper_Expiration ¶
type DhcpOperData_Dhcpv4ServerOper_Expiration struct { EntityData types.CommonEntityData YFilter yfilter.YFilter // Date and time of expiry . The type is string with pattern: // \d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[\+\-]\d{2}:\d{2}). Time interface{} // Expiry time infinite. The type is interface{}. Infinite interface{} }
DhcpOperData_Dhcpv4ServerOper_Expiration Expiration time infomation
func (*DhcpOperData_Dhcpv4ServerOper_Expiration) GetEntityData ¶
func (expiration *DhcpOperData_Dhcpv4ServerOper_Expiration) GetEntityData() *types.CommonEntityData
type DhcpServerBindingState ¶
type DhcpServerBindingState string
DhcpServerBindingState represents DHCP server binding states
const ( // Server state is in Selecting mode DhcpServerBindingState_dhcp_server_binding_state_selecting DhcpServerBindingState = "dhcp-server-binding-state-selecting" // Server state Active new address provided DhcpServerBindingState_dhcp_server_binding_state_active DhcpServerBindingState = "dhcp-server-binding-state-active" // Server terminated the connection with a client DhcpServerBindingState_dhcp_server_binding_state_terminated DhcpServerBindingState = "dhcp-server-binding-state-terminated" // Server state unknown DhcpServerBindingState_dhcp_server_binding_state_unknown DhcpServerBindingState = "dhcp-server-binding-state-unknown" )
type DhcpServerBindingType ¶
type DhcpServerBindingType string
DhcpServerBindingType represents DHCP server binding type
const ( // Server binding Type Manual DhcpServerBindingType_dhcp_server_binding_type_manual DhcpServerBindingType = "dhcp-server-binding-type-manual" // Sever binding type Static DhcpServerBindingType_dhcp_server_binding_type_static DhcpServerBindingType = "dhcp-server-binding-type-static" // Server binding type relay DhcpServerBindingType_dhcp_server_binding_type_relay DhcpServerBindingType = "dhcp-server-binding-type-relay" // Server binding type automatic DhcpServerBindingType_dhcp_server_binding_type_automatic DhcpServerBindingType = "dhcp-server-binding-type-automatic" // Server binding Type ODAP DhcpServerBindingType_dhcp_server_binding_type_odap DhcpServerBindingType = "dhcp-server-binding-type-odap" // Sever binding type from AAA DhcpServerBindingType_dhcp_server_binding_type_from_aaa DhcpServerBindingType = "dhcp-server-binding-type-from-aaa" // Server binding type remembered DhcpServerBindingType_dhcp_server_binding_type_remembered DhcpServerBindingType = "dhcp-server-binding-type-remembered" )