subscriber-mgmt
config
7210 SAS-K 2F6C4T and 7210 SAS-K 3SFP+ 8C
Commands in this context configure subscriber management entities. A subscriber is uniquely identified by a subscriber identification string. Each subscriber can have one DHCP session active at any time. Each session is referred to as a subscriber host and is identified by its IP address and MAC address.
On 7210 SAS-K 2F6C4T, the 7x50 subscriber management CLI is inherited to allow users to configure a DHCP address for specific hosts when using DHCP server for local craft access. 7210 SAS platforms do not support subscriber management. In all the commands under this section, in the context of 7210 SAS usage, DHCP subscriber refers to an IP host requesting an IP address.
local-user-db local-user-db-name [create]
config>subscr-mgmt
7210 SAS-K 2F6C4T and 7210 SAS-K 3SFP+ 8C
This command configures a local user database.
no local-user-db
Specifies the name of a local user database.
Keyword to create the local user database.
ipoe
config>subscr-mgmt>loc-user-db
7210 SAS-K 2F6C4T and 7210 SAS-K 3SFP+ 8C
This command configures IPoE host parameters.
mask type dhcp-match-type {[prefix-string prefix-string | prefix-length prefix-length] [suffix-string suffix-string | suffix-length suffix-length]}
no mask type dhcp-match-type
config>subscr-mgmt>loc-user-db>ipoe
7210 SAS-K 2F6C4T and 7210 SAS-K 3SFP+ 8C
This command configures the mask.
Specifies up to four matching types to identify a host.
Specifies a substring that is removed from the start of the incoming circuit ID before it is matched against the value configured in the DHCP or PPPOE circuit ID. This string can contain only printable ASCII characters. The ‟*” character is a wildcard that matches any substring. If a ‟\” character is masked, use the escape key so it becomes ‟\\”.
Specifies the number of characters to remove from the start of the incoming circuit ID before it is matched against the value configured in the DHCP circuit ID.
Specifies a substring that is removed from the end of the incoming circuit ID before it is matched against the value configured in DHCP circuit ID. This string can only contain printable ASCII characters. The ‟*” character is a wildcard that matches any substring. If a ‟\” character is masked, use the escape key so it becomes ‟\\”.
Specifies the number of characters to remove from the end of the incoming circuit ID before it is matched against the value configured in the DHCP circuit ID.
host host-name [create]
no host host-name
config>subscr-mgmt>loc-user-db>ipoe
7210 SAS-K 2F6C4T and 7210 SAS-K 3SFP+ 8C
This command defines a DHCP subscriber.
Specifies the host name.
Keyword used to create the host name. The create keyword requirement can be enabled or disabled in the environment>create context.
address gi-address [scope scope]
address ip-address[/prefix-length]
address pool pool-name [secondary-pool sec-pool-name] [delimiter delimiter]
address use-pool-from-client [delimiter delimiter]
no address
config>subscr-mgmt>loc-user-db>ipoe>host
7210 SAS-K 2F6C4T and 7210 SAS-K 3SFP+ 8C
This command configures the IP address definition for the host.
When the user database is from a local DHCP server, this command defines the IP address the server ‟offers” to the DHCP-client.
When the user database is used for PPPoE authentication, the gi-address parameter cannot be used. A fixed IP address then causes PPPoE to use this IP address. If no IP address is specified, the PPPoE looks for an IP address by other means (in this case, DHCP). If a pool name is specified, this pool is sent in the DHCP request so that it can be used by the DHCP server to determine which address to give to the host.
The no form of this command causes no IP address to be assigned to this host. In a user database referred to from a local DHCP server, creating a host without address information causes the matching client to never receive an IP address.
The no form of this command reverts to the default.
no address
When specified, the gi-address of the DHCP message is taken to look for a subnet in the local DHCP server. The first available free address of the subnet is taken and ‟offered” to the host. When local-user-db is used for PPPoE authentication, this has the same result as no address.
Specifies the fixed IP address to use for this host.
Specifies the primary (and secondary) pool (in the local DHCP server) to use to search for an available address. The first available IP address from any subnet in the pool is used. When the local user database is used for PPPoE authentication, the specified pool name is sent to the DHCP server in a vendor-specific suboption under Option 82
Specifies to use the pool-name in the Option 82 vendor-specific suboption.
Specifies a single ASCII character as the delimiter to separate primary and secondary pool names in Option 82 VSO.
gi-address ip-address
no gi-address
config>subscr-mgmt>loc-user-db>ipoe>host
7210 SAS-K 2F6C4T and 7210 SAS-K 3SFP+ 8C
This command configures the selection of GI addresses based on the host entry in local use database.
The gi-address must be a valid address (associated with an interface) within the routing context that received the DHCP message on the access side.
no gi-address
Specifies the IPv4 GI address.
auth-domain-name domain-name
no auth-domain-name
config>subscr-mgmt>loc-user-db>ipoe>host
7210 SAS-K 2F6C4T and 7210 SAS-K 3SFP+ 8C
This command specifies the domain name that is appended to a user name in RADIUS-authentication-request messages for the specific host.
Specifies the domain name to be appended to a user name in RADIUS-authentication-request message for the specific host.
host-identification
config>subscr-mgmt>loc-user-db>ipoe>host
7210 SAS-K 2F6C4T and 7210 SAS-K 3SFP+ 8C
Commands in this context configure host identification parameters.
server ip-address
no server
config>subscr-mgmt>loc-user-db>ipoe>host
7210 SAS-K 2F6C4T and 7210 SAS-K 3SFP+ 8C
This command configures the IP address of the DHCP server to which to relay.
The no form of this command removes the DHCP server IP address from the configuration.
The configured DHCP server IP address must reference one of the addresses configured under the DHCP CLI context of an IES or VPRN subscriber.
no server
Specifies the IP address of the DHCP server.
circuit-id string ascii-string
circuit-id hex hex-string
no circuit-id
config>subscr-mgmt>loc-user-db>ipoe>host>host-ident
7210 SAS-K 2F6C4T and 7210 SAS-K 3SFP+ 8C
This command specifies the circuit ID to match.
Specifies the circuit ID from the Option 82.
Specifies the circuit ID in hexadecimal format from the Option 82.
encap-tag-range start-tag start-tag end-tag end-tag
no encap-tag-range
config>subscr-mgmt>loc-user-db>ipoe>host>host-ident
7210 SAS-K 2F6C4T and 7210 SAS-K 3SFP+ 8C
This command configures a range of encapsulation tags as the host identifications. The encapsulation tag is dot1q or qinq on an Ethernet port.
For dot1q, the start and end tag is single number, ranging from 0 ti 4094; for QinQ, the start and end tag format is x.y, x or y could be ‟*”, which indicates to ignore the inner or outer tag.
This command can be used only when encap-tag-range is configured as one of the match-list parameters.
The no form of this command removes the values from the configuration.
Specifies the value of the start label in the range of SAPs allowed on this host.
Specifies the value of the end label in the range of SAPs allowed on this host.
mac ieee-address
no mac
config>subscr-mgmt>loc-user-db>ipoe>host>host-ident
7210 SAS-K 2F6C4T and 7210 SAS-K 3SFP+ 8C
This command specifies the MAC address to match.
Specifies the 48-bit MAC address in the form aa:bb:cc:dd:ee:ff or aa-bb-cc-dd-ee-ff, where aa, bb, cc, dd, ee, and ff are hexadecimal numbers.
option60 hex-string
no option60
config>subscr-mgmt>loc-user-db>ipoe>host>host-ident
7210 SAS-K 2F6C4T and 7210 SAS-K 3SFP+ 8C
This command specifies the Vendor-Identifying Vendor Option to match. Option 60 is encoded as Type-Length-Value (TLV). The hex-string portion of Option 60 in the received DHCP request is used for matching. Only the first 32 bytes can be defined using this command. If Option 60 included in the message is longer, those bytes are ignored.
The no form of this command reverts to the default.
no option60
Specifies the hex value of this option.
remote-id hex-string
remote-id ascii-string
no remote-id
config>subscr-mgmt>loc-user-db>ipoe>host>host-ident
7210 SAS-K 2F6C4T and 7210 SAS-K 3SFP+ 8C
This command specifies the remote ID of the host.
The no form of this command reverts to the default value.
no remote-id
Specifies the remote ID.
sap-id sap-id
no sap-id
config>subscr-mgmt>loc-user-db>ipoe>host>host-ident
7210 SAS-K 2F6C4T and 7210 SAS-K 3SFP+ 8C
This command specifies the SAP ID from the Nokia vendor-specific suboption in Option 82 to match.
Specifies a SAP ID, up to 255 characters.
service-id service-id
no service-id
config>subscr-mgmt>loc-user-db>ipoe>host>host-ident
7210 SAS-K 2F6C4T and 7210 SAS-K 3SFP+ 8C
This command specifies an existing service ID from the Nokia vendor-specific suboption in Option 82 to match.
Specifies an existing service ID.
string string
no string
config>subscr-mgmt>loc-user-db>ipoe>host>host-ident
7210 SAS-K 2F6C4T and 7210 SAS-K 3SFP+ 8C
This command specifies the string from the Nokia vendor-specific suboption in Option 82 to match.
Specifies the string, up to 255 characters.
system-id system-id
no system-id
config>subscr-mgmt>loc-user-db>ipoe>host>host-ident
7210 SAS-K 2F6C4T and 7210 SAS-K 3SFP+ 8C
This command specifies the system ID from the Nokia vendor-specific suboption in Option 82 to match.
Specifies the system ID, up to 255 characters.
options
config>subscr-mgmt>loc-user-db>ipoe>host
7210 SAS-K 2F6C4T and 7210 SAS-K 3SFP+ 8C
Commands in this context configure pool options. The options defined at the host level are overruled if the same option is defined at the local user database level.
custom-option option-number address [ip-address...(up to 4 max)]
custom-option option-number hex hex-string
custom-option option-number string ascii-string
no custom-option option-number
config>subscr-mgmt>loc-user-db>ipoe>host>options
7210 SAS-K 2F6C4T and 7210 SAS-K 3SFP+ 8C
This command configures specific DHCP options. The options defined at the host level are overruled if the same option is defined at the local user database level.
The no form of this command removes the option from the configuration.
Specifies the option number that the DHCP server uses to send the identification strings to the DHCP client.
Specifies the IP address of this host.
Specifies the hex value of this option.
Specifies the value of this option, up to 127 characters.
default-router ip-address [ip-address...(up to 4 max)]
no default-router
config>subscr-mgmt>loc-user-db>ipoe>host>options
7210 SAS-K 2F6C4T and 7210 SAS-K 3SFP+ 8C
This command configures the IP address of the default router for a DHCP client. Up to four IP addresses can be specified.
The no form of this command removes the addresses from the configuration.
Specifies the IP address of the default router. This address must be unique within the subnet and specified in dotted decimal notation.
dns-server address [ip-address...(up to 4 max)]
no dns-server
config>subscr-mgmt>loc-user-db>ipoe>host>options
7210 SAS-K 2F6C4T and 7210 SAS-K 3SFP+ 8C
This command configures the IP address of the DNS server.
Specifies the IPv4 address of the DNS server. This address must be unique within the subnet and specified in dotted decimal notation.
domain-name domain-name
no domain-name
config>subscr-mgmt>loc-user-db>ipoe>host>options
7210 SAS-K 2F6C4T and 7210 SAS-K 3SFP+ 8C
This command configures the default domain for a DHCP client that the router uses to complete unqualified host names (without a dotted-decimal domain name).
The no form of this command removes the name from the configuration.
Specifies the domain name for the client, up to 127 characters.
lease-rebind-time [days days] [hrs hours] [min minutes] [sec seconds]
no lease-rebind-time
config>subscr-mgmt>loc-user-db>ipoe>host>options
7210 SAS-K 2F6C4T and 7210 SAS-K 3SFP+ 8C
This command configures the time the client transitions to a rebinding state.
The no form of this command removes the time from the configuration.
Specifies the number of days in the lease rebind time.
Specifies the number of hours in the lease rebind time.
Specifies the number of minutes in the lease rebind time.
Specifies the number of seconds in the lease rebind time.
lease-renew-time [days days] [hrs hours] [min minutes] [sec seconds]
no lease-renew-time
config>subscr-mgmt>loc-user-db>ipoe>host>options
7210 SAS-K 2F6C4T and 7210 SAS-K 3SFP+ 8C
This command configures the time the client transitions to a renew state.
The no form of this command removes the time from the configuration.
Specifies the number of days in the lease renew time.
Specifies the number of hours in the lease renew time.
Specifies the number of minutes in the lease renew time.
Specifies the number of seconds in the lease renew time.
lease-time [days days] [hrs hours] [min minutes] [sec seconds]
no lease-time
config>subscr-mgmt>loc-user-db>ipoe>host>options
7210 SAS-K 2F6C4T and 7210 SAS-K 3SFP+ 8C
This command configures the amount of time that the DHCP server grants to the DHCP client to use a particular IP address.
The no form of this command removes the lease time parameters from the configuration.
Specifies the number of days in the lease time.
Specifies the number of hours in the lease time.
Specifies the number of minutes in the lease time.
Specifies the number of seconds in the lease time.
subnet-mask ip-address
no subnet-mask
config>subscr-mgmt>loc-user-db>ipoe>host>options
7210 SAS-K 2F6C4T and 7210 SAS-K 3SFP+ 8C
This command specifies the subnet-mask option to the client. The mask can either be defined (for supernetting) or taken from the pool address.
The no form of this command removes the address from the configuration.
Specifies the IP address of the subnet mask. This address must be unique within the subnet and specified in dotted decimal notation.
mask type dhcp-match-type {[prefix-string prefix-string | prefix-length prefix-length] [suffix-string suffix-string | suffix-length suffix-length]}
no mask type dhcp-match-type
config>subscr-mgmt>loc-user-db>ipoe
7210 SAS-K 2F6C4T and 7210 SAS-K 3SFP+ 8C
This command configures the mask.
Specifies the data type that represents the type of matching done to identify a DHCP host.
Specifies a substring that is stripped of the start of the incoming circuit ID before it is matched against the value configured in the DHCP circuit ID. This string can only contain printable ASCII characters. The ‟*” character is a wildcard that matches any substring. If a "\" character is masked, use the escape key so it becomes "\\".
Specifies the number of characters to remove from the start of the incoming circuit ID before it is matched against the value configured in the circuit ID.
Specifies a substring that is stripped of the end of the incoming circuit ID before it is matched against the value configured in circuit ID.
This string can contain only printable ASCII characters. The ‟*” character is a wildcard that matches any substring. If a "\" character is masked, use the escape key so it becomes "\\".
Specifies the number of characters to remove from the end of the incoming circuit ID before it is matched against the value configured in the circuit ID.
match-list match-type-1 [match-type-2...(up to 4 max)]
no match-list
config>subscr-mgmt>loc-user-db>ipoe
7210 SAS-K 2F6C4T and 7210 SAS-K 3SFP+ 8C
This command specifies the type of matching done to identify a host.
no match-list
Specifies up to four matching types to identify a host.
[no] shutdown
config>subscr-mgmt>loc-user-db
config>subscr-mgmt>loc-user-db>ipoe>host
7210 SAS-K 2F6C4T and 7210 SAS-K 3SFP+ 8C
This command administratively disables an entity. When disabled, an entity does not change, reset, or remove any configuration settings or statistics.
The operational state of the entity is disabled as well as the operational state of any entities contained within. Many objects must be shut down before they may be deleted.
The no form of this command places the entity into an administratively enabled state.