CISCO-IETF-DHCP-SERVER-MIB

SnmpAdminStringAn octet string containing administrative information, preferably in human-readable form. To facilitate internationalization, this information is represented using the ISO/IEC IS 10646-1 character set, encoded as an octet string using the UTF-8 transformation format described in [RFC2279]. Since additional code points are added by amendments to the 10646 standard from time to time, implementations must be prepared to encounter any code point from 0x00000000 to 0x7fffffff. Byte sequences that do not correspond to the valid UTF-8 encoding of a code point or are outside this range are prohibited. The use of control codes should be avoided. When it is necessary to represent a newline, the control code sequence CR LF should be used. The use of leading or trailing white space should be avoided. For code points not directly supported by user interface hardware or software, an alternative means of entry and display, such as hexadecimal, may be provided. For information encoded in 7-bit US-ASCII, the UTF-8 encoding is identical to the US-ASCII encoding. UTF-8 may require multiple bytes to represent a single character / code point; thus the length of this object in octets may be different from the number of characters encoded. Similarly, size constraints refer to the number of encoded octets, not the number of characters represented by an encoding. Note that when this TC is used for an object that is used or envisioned to be used as an index, then a SIZE restriction MUST be specified so that the number of sub-identifiers for any object instance does not exceed the limit of 128, as defined by [RFC3416]. Note that the size of an SnmpAdminString object is measured in octets, not characters. SIZE (1..100) · OCTET STRING · hint 255t

The name of the shared network, which uniquely identifies an entry in the cDhcpv4ServerSharedNetTable.

Unsigned32

The low threshold for available free addresses in this shared network. If the value for available free addresses in this shared network becomes equal to or less than this value, a cDhcpv4ServerFreeAddressLow event is generated for this shared network. No more cDhcpv4ServerFreeAddressLow events will be generated for this subnet during this execution of the DHCP server until the value for available free addresses has exceeded the value of cDhcpv4ServerSharedNetFreeAddrHighThreshold.

Unsigned32

The high threshold for available free addresses in this shared network. If a cDhcpv4ServerFreeAddressLow event was generated for this subnet, and the value for available free addresses has exceeded the value of cDhcpv4ServerSubnetFreeAddrHighThreshold, then a cDhcpv4ServerFreeAddressHigh event will be generated. No more cDhcpv4ServerFreeAddressHigh events will be generated for this subnet during this execution of the DHCP server until the value for available free addresses becomes equal to or less than the value of cDhcpv4ServerSubnetFreeAddrLowThreshold.

Unsigned32

The number of IPv4 addresses which are available within this shared network. If the server does not count free addresses by shared network segment, this value will be zero.

Unsigned32

The number of IPv4 addresses which are reserved (not available for assignment) within this shared network. If the server does not count reserved addresses by shared network segment, this value will be zero.

Unsigned32

The number of IPv4 addresses which are available within this shared network. If the server does not count total addresses by shared network segment, this value will be zero.

InetAddressIPv4Represents an IPv4 network address: Octets Contents Encoding 1-4 IPv4 address network-byte order The corresponding InetAddressType value is ipv4(1). This textual convention SHOULD NOT be used directly in object definitions, as it restricts addresses to a specific format. However, if it is used, it MAY be used either on its own or in conjunction with InetAddressType, as a pair. SIZE (4) · OCTET STRING · hint 1d.1d.1d.1d

The IPv4 address of the subnet entry in the cDhcpv4ServerSubnetTable.

InetAddressPrefixLengthDenotes the length of a generic Internet network address prefix. A value of n corresponds to an IP address mask that has n contiguous 1-bits from the most significant bit (MSB), with all other bits set to 0. An InetAddressPrefixLength value is always interpreted within the context of an InetAddressType value. Every usage of the InetAddressPrefixLength textual convention is required to specify the InetAddressType object that provides the context. It is suggested that the InetAddressType object be logically registered before the object(s) that use the InetAddressPrefixLength textual convention, if they appear in the same logical row. InetAddressPrefixLength values larger than the maximum length of an IP address for a specific InetAddressType are treated as the maximum significant value applicable for the InetAddressType. The maximum significant value is 32 for the InetAddressType 'ipv4(1)' and 'ipv4z(3)' and 128 for the InetAddressType 'ipv6(2)' and 'ipv6z(4)'. The maximum significant value for the InetAddressType 'dns(16)' is 0. The value zero is object-specific and must be defined as part of the description of any object that uses this syntax. Examples of the usage of zero might include situations where the Internet network address prefix is unknown or does not apply. The upper bound of the prefix length has been chosen to be consistent with the maximum size of an InetAddress. (0..2040) · Unsigned32 · hint d

The subnet mask of the subnet. This MUST be the same as the value of DHCP option 1 offered to clients on this subnet.

SnmpAdminStringAn octet string containing administrative information, preferably in human-readable form. To facilitate internationalization, this information is represented using the ISO/IEC IS 10646-1 character set, encoded as an octet string using the UTF-8 transformation format described in [RFC2279]. Since additional code points are added by amendments to the 10646 standard from time to time, implementations must be prepared to encounter any code point from 0x00000000 to 0x7fffffff. Byte sequences that do not correspond to the valid UTF-8 encoding of a code point or are outside this range are prohibited. The use of control codes should be avoided. When it is necessary to represent a newline, the control code sequence CR LF should be used. The use of leading or trailing white space should be avoided. For code points not directly supported by user interface hardware or software, an alternative means of entry and display, such as hexadecimal, may be provided. For information encoded in 7-bit US-ASCII, the UTF-8 encoding is identical to the US-ASCII encoding. UTF-8 may require multiple bytes to represent a single character / code point; thus the length of this object in octets may be different from the number of characters encoded. Similarly, size constraints refer to the number of encoded octets, not the number of characters represented by an encoding. Note that when this TC is used for an object that is used or envisioned to be used as an index, then a SIZE restriction MUST be specified so that the number of sub-identifiers for any object instance does not exceed the limit of 128, as defined by [RFC3416]. Note that the size of an SnmpAdminString object is measured in octets, not characters. SIZE (1..100) · OCTET STRING · hint 255t

The shared subnet name (used as an index into the server shared subnet table) to which this subnet belongs. This value will be null for servers that do not organize or describe networks in this manner.

Unsigned32

The low threshold for available free addresses in this subnet. If the value for available free addresses in this subnet becomes equal to or less than this value, a cDhcpv4ServerSubnetFreeAddrLowThreshold event will be generated for this shared network. No more cDhcpv4ServerSubnetFreeAddrLowThreshold events will be generated for this subnet during this execution of the DHCP server until the value for available free addresses has exceeded the value of cDhcpv4ServerSubnetFreeAddrHighThreshold.

Unsigned32

The high threshold for available free addresses in this subnet. If a cDhcpv4ServerSubnetFreeAddrLowThreshold event has been generated for this subnet, and the value for available free addresses has exceeded the value of cDhcpv4ServerSubnetFreeAddrHighThreshold, then a cDhcpv4ServerFreeAddressHigh event will be generated. No more cDhcpv4ServerFreeAddressHigh events will be generated for this subnet during this execution of the DHCP server until the value for available free addresses becomes equal to or less than the value of cDhcpv4ServerSubnetFreeAddrLowThreshold.

Unsigned32

The number of free IPv4 addresses which are available in this subnet.

InetAddressIPv4Represents an IPv4 network address: Octets Contents Encoding 1-4 IPv4 address network-byte order The corresponding InetAddressType value is ipv4(1). This textual convention SHOULD NOT be used directly in object definitions, as it restricts addresses to a specific format. However, if it is used, it MAY be used either on its own or in conjunction with InetAddressType, as a pair. SIZE (4) · OCTET STRING · hint 1d.1d.1d.1d

The IPv4 address of the first address in the range. The value of cDhcpv4ServerRangeStartAddress MUST be less than or equal to the value of cDhcpv4ServerRangeEndAddress.

InetAddressIPv4Represents an IPv4 network address: Octets Contents Encoding 1-4 IPv4 address network-byte order The corresponding InetAddressType value is ipv4(1). This textual convention SHOULD NOT be used directly in object definitions, as it restricts addresses to a specific format. However, if it is used, it MAY be used either on its own or in conjunction with InetAddressType, as a pair. SIZE (4) · OCTET STRING · hint 1d.1d.1d.1d

The IPv4 address of the last address in the range. The value of cDhcpv4ServerRangeEndAddress MUST be greater than or equal to the value of cDhcpv4ServerRangeStartAddress.

InetAddressPrefixLengthDenotes the length of a generic Internet network address prefix. A value of n corresponds to an IP address mask that has n contiguous 1-bits from the most significant bit (MSB), with all other bits set to 0. An InetAddressPrefixLength value is always interpreted within the context of an InetAddressType value. Every usage of the InetAddressPrefixLength textual convention is required to specify the InetAddressType object that provides the context. It is suggested that the InetAddressType object be logically registered before the object(s) that use the InetAddressPrefixLength textual convention, if they appear in the same logical row. InetAddressPrefixLength values larger than the maximum length of an IP address for a specific InetAddressType are treated as the maximum significant value applicable for the InetAddressType. The maximum significant value is 32 for the InetAddressType 'ipv4(1)' and 'ipv4z(3)' and 128 for the InetAddressType 'ipv6(2)' and 'ipv6z(4)'. The maximum significant value for the InetAddressType 'dns(16)' is 0. The value zero is object-specific and must be defined as part of the description of any object that uses this syntax. Examples of the usage of zero might include situations where the Internet network address prefix is unknown or does not apply. The upper bound of the prefix length has been chosen to be consistent with the maximum size of an InetAddress. (0..2040) · Unsigned32 · hint d

The subnet address mask for this range.

Gauge32

The number of addresses in this range that are currently in use. This number includes those addresses whose lease has not expired and addresses which have been reserved (either by the server or through configuration).

Gauge32

The number of outstanding DHCPOFFER messages for this range is reported with this value. An offer is outstanding if the server has sent a DHCPOFFER message to a client, but has not yet received a DHCPREQUEST message from the client nor has the server-specific timeout (limiting the time in which a client can respond to the offer message) for the offer message expired.

InetAddressIPv4Represents an IPv4 network address: Octets Contents Encoding 1-4 IPv4 address network-byte order The corresponding InetAddressType value is ipv4(1). This textual convention SHOULD NOT be used directly in object definitions, as it restricts addresses to a specific format. However, if it is used, it MAY be used either on its own or in conjunction with InetAddressType, as a pair. SIZE (4) · OCTET STRING · hint 1d.1d.1d.1d

The IPv4 address of this entry in the cDhcpv4ServerClientTable.

InetAddressPrefixLengthDenotes the length of a generic Internet network address prefix. A value of n corresponds to an IP address mask that has n contiguous 1-bits from the most significant bit (MSB), with all other bits set to 0. An InetAddressPrefixLength value is always interpreted within the context of an InetAddressType value. Every usage of the InetAddressPrefixLength textual convention is required to specify the InetAddressType object that provides the context. It is suggested that the InetAddressType object be logically registered before the object(s) that use the InetAddressPrefixLength textual convention, if they appear in the same logical row. InetAddressPrefixLength values larger than the maximum length of an IP address for a specific InetAddressType are treated as the maximum significant value applicable for the InetAddressType. The maximum significant value is 32 for the InetAddressType 'ipv4(1)' and 'ipv4z(3)' and 128 for the InetAddressType 'ipv6(2)' and 'ipv6z(4)'. The maximum significant value for the InetAddressType 'dns(16)' is 0. The value zero is object-specific and must be defined as part of the description of any object that uses this syntax. Examples of the usage of zero might include situations where the Internet network address prefix is unknown or does not apply. The upper bound of the prefix length has been chosen to be consistent with the maximum size of an InetAddress. (0..2040) · Unsigned32 · hint d

The subnet mask (DHCP option 1) provided to the client offered this address. The subnet, resulting from logically ANDing the subnet mask with the entry's IPv4 address, MUST be configured on this server and appear as a row in the cDhcpSubnetTable.

InetAddressIPv4Represents an IPv4 network address: Octets Contents Encoding 1-4 IPv4 address network-byte order The corresponding InetAddressType value is ipv4(1). This textual convention SHOULD NOT be used directly in object definitions, as it restricts addresses to a specific format. However, if it is used, it MAY be used either on its own or in conjunction with InetAddressType, as a pair. SIZE (4) · OCTET STRING · hint 1d.1d.1d.1d

The starting IPv4 address (cDhcpv4ServerRangeStartAddress object) of the range to which this address belongs. If the address does not fall into one of the configured ranges (e.g., a statically configured address on a subnet) the range MAY be 0.0.0.0.

INTEGER1 = static2 = dynamic3 = expired4 = configurationReserved5 = serverReserved · Integer32

The type of this address. Types are: (1) Static addresses defined by the server configuration. (2) Dynamic addresses defined by the server configuration AND actually assigned by the server. (3) Expired dynamic addresses, previously assigned by the server, and 'remembered' for subsequent assignment to the same host. (4) Addresses reserved (i.e., not assignable) by the server configuration. (5) Addresses previously assigned by the server, but temporarily or permanently removed from assignable state for some reason, e.g., the server received an ICMP ECHOREPLY for the IPv4 address or a DHCPDECLINE message has been received for the IPv4 address.

Unsigned32

The number of seconds until the lease expires. A value of 4294967295 (i.e., 0xFFFFFFFF) SHOULD be used for leases that have a lease time which is 'infinite' and for BOOTP leases.

INTEGER1 = none2 = bootp3 = dhcp4 = bootpOrDhcp · Integer32

The type of protocol that is allowed to be used to serve this address. A type of none (1) indicates that the address is not available to be served (e.g., a reserved address). Type (2) is reserved for BOOTP only devices, while type (3) is reserved for DHCP only devices. A type of bootp-or-dhcp (4) can be offered to any type of client.

INTEGER1 = none2 = bootp3 = dhcp · Integer32

The type of protocol that was used when this address was assigned. This object will have the value of none (1) if the address has not been served.

CDhcpv4PhysicalAddressA DHCP-specific encoding of the physical address type and physical address, intended to mirror the representation of physical addresses in DHCP messages. The first octet of this object contains the hardware type from the 'htype' field of the DHCP message, the second octet of this object contains the hardware length from the 'hlen' field, and the remaining octets contain the hardware address from the 'chaddr' field.Reference: RFC 2131 SIZE (18) · OCTET STRING · hint 1d,1d,1x:1x:1x:1x:1x:1x

The hardware type and hardware address of the client that has been assigned this lease. The first octet of this object contains the hardware type from the 'htype' field of the BOOTP packet and the remaining octets contain the hardware address from the 'chaddr' field of the BOOTP packet. This object MAY be empty if the address has not been previously served.

OCTET STRING SIZE (0..255)

The client-id of the client that has been assigned this lease. The client-id is the value specified in option 61 (client-id option) when the lease was assigned. This object MAY be empty if the lease has not been previously assigned or if the client-id option was not specified when the address was assigned.

SnmpAdminStringAn octet string containing administrative information, preferably in human-readable form. To facilitate internationalization, this information is represented using the ISO/IEC IS 10646-1 character set, encoded as an octet string using the UTF-8 transformation format described in [RFC2279]. Since additional code points are added by amendments to the 10646 standard from time to time, implementations must be prepared to encounter any code point from 0x00000000 to 0x7fffffff. Byte sequences that do not correspond to the valid UTF-8 encoding of a code point or are outside this range are prohibited. The use of control codes should be avoided. When it is necessary to represent a newline, the control code sequence CR LF should be used. The use of leading or trailing white space should be avoided. For code points not directly supported by user interface hardware or software, an alternative means of entry and display, such as hexadecimal, may be provided. For information encoded in 7-bit US-ASCII, the UTF-8 encoding is identical to the US-ASCII encoding. UTF-8 may require multiple bytes to represent a single character / code point; thus the length of this object in octets may be different from the number of characters encoded. Similarly, size constraints refer to the number of encoded octets, not the number of characters represented by an encoding. Note that when this TC is used for an object that is used or envisioned to be used as an index, then a SIZE restriction MUST be specified so that the number of sub-identifiers for any object instance does not exceed the limit of 128, as defined by [RFC3416]. Note that the size of an SnmpAdminString object is measured in octets, not characters. SIZE (1..255) · OCTET STRING · hint 255t

The host name (DHCP option 12) the client is configured to use, or if no host name was configured then the host name that the client supplied when requesting an address. While this object has a maximum size of 255 octets, a Fully-Qualified Domain Name (FQDN) consisting of a Host Name part and a Domain Name part is currently limited to 255 octets. Therefore, the sum of the string lengths for this object and the cDhcpv4ServerClientDomainName MUST be, in practice, less than 256 octets.

SnmpAdminStringAn octet string containing administrative information, preferably in human-readable form. To facilitate internationalization, this information is represented using the ISO/IEC IS 10646-1 character set, encoded as an octet string using the UTF-8 transformation format described in [RFC2279]. Since additional code points are added by amendments to the 10646 standard from time to time, implementations must be prepared to encounter any code point from 0x00000000 to 0x7fffffff. Byte sequences that do not correspond to the valid UTF-8 encoding of a code point or are outside this range are prohibited. The use of control codes should be avoided. When it is necessary to represent a newline, the control code sequence CR LF should be used. The use of leading or trailing white space should be avoided. For code points not directly supported by user interface hardware or software, an alternative means of entry and display, such as hexadecimal, may be provided. For information encoded in 7-bit US-ASCII, the UTF-8 encoding is identical to the US-ASCII encoding. UTF-8 may require multiple bytes to represent a single character / code point; thus the length of this object in octets may be different from the number of characters encoded. Similarly, size constraints refer to the number of encoded octets, not the number of characters represented by an encoding. Note that when this TC is used for an object that is used or envisioned to be used as an index, then a SIZE restriction MUST be specified so that the number of sub-identifiers for any object instance does not exceed the limit of 128, as defined by [RFC3416]. Note that the size of an SnmpAdminString object is measured in octets, not characters. SIZE (1..255) · OCTET STRING · hint 255t

The domain name (DHCP option 15) assigned to the client. While this object has a maximum size of 255 octets, a Fully- Qualified Domain Name (FQDN) consisting of a Host Name part and a Domain Name part is currently limited to 255 octets, less the separator ('.') character. Therefore, the sum of the string lengths for this object and the cDhcpv4ServerClientHostName MUST be, in practice, less than 256 octets.