subscriber-mgmt commands

configure 
   —  subscriber-mgmt 
      —  apply-groups reference
      —  apply-groups-exclude reference
      —  local-user-db named-item 
         —  admin-state keyword
         —  apply-groups reference
         —  apply-groups-exclude reference
         —  description description
         —  ipoe 
            —  host named-item 
               —  admin-state keyword
               —  apply-groups reference
               —  apply-groups-exclude reference
               —  authentication 
               —  host-identification 
                  —  circuit-id 
                     —  ascii-string string
                     —  hex-string hex-string
                  —  duid-en 
                     —  hex-string hex-string
                  —  duid-ll-llt mac-unicast-address-no-zero
                  —  mac mac-unicast-address-no-zero
                  —  option60 
                     —  ascii-string named-item
                     —  hex-string hex-string
                  —  remote-id 
                     —  ascii-string string
                     —  hex-string hex-string
                  —  sap-id display-string
                  —  service-id number
                  —  string display-string
                  —  system-id display-string
               —  ipv4 
                  —  address 
                     —  gi-address keyword
                     —  ip-address ipv4-unicast-address
                     —  pool 
                        —  delimiter string
                        —  primary named-item
                        —  secondary named-item
                     —  use-pool-from-client 
                        —  delimiter string
                  —  gi-address ipv4-unicast-address
                  —  option (number | keyword) 
                     —  apply-groups reference
                     —  apply-groups-exclude reference
                     —  ascii-string string-not-all-spaces
                     —  duration number
                     —  empty 
                     —  hex-string hex-string
                     —  ipv4-address ipv4-address
                     —  netbios-node-type keyword
            —  mask type keyword 
               —  apply-groups reference
               —  apply-groups-exclude reference
               —  prefix 
                  —  length number
                  —  string string
               —  suffix 
                  —  length number
                  —  string string
            —  match-list keyword
      —  rip-policy named-item 
         —  apply-groups reference
         —  apply-groups-exclude reference
         —  authentication-key encrypted-leaf
         —  authentication-type keyword
         —  description description

subscriber-mgmt command descriptions

subscriber-mgmt


	Synopsis	Enter the subscriber-mgmt context
	Context	configure subscriber-mgmt
	Tree	subscriber-mgmt
	Description	Commands in this context configure subscriber management attributes, policies, and profiles.
	Introduced	25.3.R2
	Platforms	7705 SAR Gen 2

local-user-db [name] named-item


	Synopsis	Enter the local-user-db list instance
	Context	configure subscriber-mgmt local-user-db named-item
	Tree	local-user-db
	Max. instances	127
	Introduced	25.3.R2
	Platforms	7705 SAR Gen 2

[name] named-item


	Synopsis	Local user database name
	Context	configure subscriber-mgmt local-user-db named-item
	Tree	local-user-db
	String length	1 to 32
	Notes	This element is part of a list key.
	Introduced	25.3.R2
	Platforms	7705 SAR Gen 2

admin-state keyword


	Synopsis	Administrative state of the local user database
	Context	configure subscriber-mgmt local-user-db named-item admin-state keyword
	Tree	admin-state
	Options	enable, disable
	Default	disable
	Introduced	25.3.R2
	Platforms	7705 SAR Gen 2

description description


	Synopsis	Text description
	Context	configure subscriber-mgmt local-user-db named-item description description
	Tree	description
	String length	1 to 80
	Introduced	25.3.R2
	Platforms	7705 SAR Gen 2

ipoe


	Synopsis	Enter the ipoe context
	Context	configure subscriber-mgmt local-user-db named-item ipoe
	Tree	ipoe
	Introduced	25.3.R2
	Platforms	7705 SAR Gen 2

host [host-name] named-item


	Synopsis	Enter the host list instance
	Context	configure subscriber-mgmt local-user-db named-item ipoe host named-item
	Tree	host
	Introduced	25.3.R2
	Platforms	7705 SAR Gen 2

[host-name] named-item


	Synopsis	Host name
	Context	configure subscriber-mgmt local-user-db named-item ipoe host named-item
	Tree	host
	String length	1 to 32
	Notes	This element is part of a list key.
	Introduced	25.3.R2
	Platforms	7705 SAR Gen 2

admin-state keyword


	Synopsis	Administrative state of the host
	Context	configure subscriber-mgmt local-user-db named-item ipoe host named-item admin-state keyword
	Tree	admin-state
	Options	enable, disable
	Default	disable
	Introduced	25.3.R2
	Platforms	7705 SAR Gen 2

authentication


	Synopsis	Enter the authentication context
	Context	configure subscriber-mgmt local-user-db named-item ipoe host named-item authentication
	Tree	authentication
	Introduced	25.3.R2
	Platforms	7705 SAR Gen 2

host-identification


	Synopsis	Enter the host-identification context
	Context	configure subscriber-mgmt local-user-db named-item ipoe host named-item host-identification
	Tree	host-identification
	Introduced	25.3.R2
	Platforms	7705 SAR Gen 2

circuit-id


	Synopsis	Enter the circuit-id context
	Context	configure subscriber-mgmt local-user-db named-item ipoe host named-item host-identification circuit-id
	Tree	circuit-id
	Introduced	25.3.R2
	Platforms	7705 SAR Gen 2

ascii-string string


WARNING: Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.
	Synopsis	Circuit ID as ASCII string
	Context	configure subscriber-mgmt local-user-db named-item ipoe host named-item host-identification circuit-id ascii-string string
	Tree	ascii-string
	String length	1 to 127
	Notes	The following elements are part of a choice: ascii-string or hex-string.
	Introduced	25.3.R2
	Platforms	7705 SAR Gen 2

hex-string hex-string


WARNING: Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.
	Synopsis	Circuit ID as hexadecimal string
	Context	configure subscriber-mgmt local-user-db named-item ipoe host named-item host-identification circuit-id hex-string hex-string
	Tree	hex-string
	String length	1 to 256
	Notes	The following elements are part of a choice: ascii-string or hex-string.
	Introduced	25.3.R2
	Platforms	7705 SAR Gen 2

duid-en


	Synopsis	Enter the duid-en context
	Context	configure subscriber-mgmt local-user-db named-item ipoe host named-item host-identification duid-en
	Tree	duid-en
	Introduced	25.3.R2
	Platforms	7705 SAR Gen 2

hex-string hex-string


WARNING: Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.
	Synopsis	Client ID of type duid-en as a hexadecimal string
	Context	configure subscriber-mgmt local-user-db named-item ipoe host named-item host-identification duid-en hex-string hex-string
	Tree	hex-string
	Description	This command configures the hexadecimal value for use in matching against the concatenation of the enterprise number and identifier fields of the DHCPv6 option CLIENTID (1) with DUID type = 2 (assigned by the vendor based on the enterprise number) in the DHCPv6 client message.
	String length	1 to 256
	Introduced	25.3.R2
	Platforms	7705 SAR Gen 2

duid-ll-llt mac-unicast-address-no-zero


WARNING: Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.
	Synopsis	MAC address of the Client ID type duid-ll or duid-llt
	Context	configure subscriber-mgmt local-user-db named-item ipoe host named-item host-identification duid-ll-llt mac-unicast-address-no-zero
	Tree	duid-ll-llt
	Description	This command configures the value for use in matching against the link-layer address field of the DHCPv6 option CLIENTID (1) with DUID type = 3 (based on the link-layer address) or DUID type = 1 (based on the link-layer address plus time) and hardware type = 1 (Ethernet) in the DHCPv6 client message. For DUID type = 1, the time field is ignored.
	Introduced	25.3.R2
	Platforms	7705 SAR Gen 2

mac mac-unicast-address-no-zero


WARNING: Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.
	Synopsis	MAC address
	Context	configure subscriber-mgmt local-user-db named-item ipoe host named-item host-identification mac mac-unicast-address-no-zero
	Tree	mac
	Introduced	25.3.R2
	Platforms	7705 SAR Gen 2

option60


	Synopsis	Enter the option60 context
	Context	configure subscriber-mgmt local-user-db named-item ipoe host named-item host-identification option60
	Tree	option60
	Introduced	25.3.R2
	Platforms	7705 SAR Gen 2

ascii-string named-item


WARNING: Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.
	Synopsis	Option 60 as ASCII string
	Context	configure subscriber-mgmt local-user-db named-item ipoe host named-item host-identification option60 ascii-string named-item
	Tree	ascii-string
	String length	1 to 32
	Notes	The following elements are part of a choice: ascii-string or hex-string.
	Introduced	25.3.R2
	Platforms	7705 SAR Gen 2

hex-string hex-string


WARNING: Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.
	Synopsis	Option as a hexadecimal string
	Context	configure subscriber-mgmt local-user-db named-item ipoe host named-item host-identification option60 hex-string hex-string
	Tree	hex-string
	String length	1 to 64
	Notes	The following elements are part of a choice: ascii-string or hex-string.
	Introduced	25.3.R2
	Platforms	7705 SAR Gen 2

remote-id


	Synopsis	Enter the remote-id context
	Context	configure subscriber-mgmt local-user-db named-item ipoe host named-item host-identification remote-id
	Tree	remote-id
	Introduced	25.3.R2
	Platforms	7705 SAR Gen 2

ascii-string string


WARNING: Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.
	Synopsis	Remote ID as ASCII string
	Context	configure subscriber-mgmt local-user-db named-item ipoe host named-item host-identification remote-id ascii-string string
	Tree	ascii-string
	String length	1 to 255
	Notes	The following elements are part of a choice: ascii-string or hex-string.
	Introduced	25.3.R2
	Platforms	7705 SAR Gen 2

hex-string hex-string


WARNING: Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.
	Synopsis	Remote ID as hexadecimal string
	Context	configure subscriber-mgmt local-user-db named-item ipoe host named-item host-identification remote-id hex-string hex-string
	Tree	hex-string
	String length	1 to 512
	Notes	The following elements are part of a choice: ascii-string or hex-string.
	Introduced	25.3.R2
	Platforms	7705 SAR Gen 2

sap-id display-string


WARNING: Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.
	Synopsis	SAP ID
	Context	configure subscriber-mgmt local-user-db named-item ipoe host named-item host-identification sap-id display-string
	Tree	sap-id
	String length	1 to 255
	Introduced	25.3.R2
	Platforms	7705 SAR Gen 2

service-id number


WARNING: Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.
	Synopsis	Service ID
	Context	configure subscriber-mgmt local-user-db named-item ipoe host named-item host-identification service-id number
	Tree	service-id
	Range	1 to 2147483647 \| 2147483648 \| 2147483649 \| 2147483650 \| 2147483651 to 2147483690 \| 2147483691 to 2148007980 \| 2148007981 to 2148012076 \| 2148012077 to 2148016172 \| 2148016173 to 2148278316 \| 2148278317 \| 2148278318 to 2148278381 \| 2148278382 \| 2148278383 to 2148278386 \| 2148278387 to 2148282482
	Introduced	25.3.R2
	Platforms	7705 SAR Gen 2

string display-string


WARNING: Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.
	Synopsis	VSO string
	Context	configure subscriber-mgmt local-user-db named-item ipoe host named-item host-identification string display-string
	Tree	string
	String length	1 to 255
	Introduced	25.3.R2
	Platforms	7705 SAR Gen 2

system-id display-string


WARNING: Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.
	Synopsis	System ID
	Context	configure subscriber-mgmt local-user-db named-item ipoe host named-item host-identification system-id display-string
	Tree	system-id
	String length	1 to 255
	Introduced	25.3.R2
	Platforms	7705 SAR Gen 2

ipv4


	Synopsis	Enter the ipv4 context
	Context	configure subscriber-mgmt local-user-db named-item ipoe host named-item ipv4
	Tree	ipv4
	Introduced	25.3.R2
	Platforms	7705 SAR Gen 2

address


	Synopsis	Enter the address context
	Context	configure subscriber-mgmt local-user-db named-item ipoe host named-item ipv4 address
	Tree	address
	Introduced	25.3.R2
	Platforms	7705 SAR Gen 2

gi-address keyword


	Synopsis	Use gi-address to select a pool with the given scope
	Context	configure subscriber-mgmt local-user-db named-item ipoe host named-item ipv4 address gi-address keyword
	Tree	gi-address
	Options	subnet-scope, pool-scope
	Notes	The following elements are part of a choice: gi-address, ip-address, pool, or use-pool-from-client.
	Introduced	25.3.R2
	Platforms	7705 SAR Gen 2

ip-address ipv4-unicast-address


	Synopsis	Fixed IPv4 address of the host
	Context	configure subscriber-mgmt local-user-db named-item ipoe host named-item ipv4 address ip-address ipv4-unicast-address
	Tree	ip-address
	Notes	The following elements are part of a choice: gi-address, ip-address, pool, or use-pool-from-client.
	Introduced	25.3.R2
	Platforms	7705 SAR Gen 2

pool


	Synopsis	Enable the pool context
	Context	configure subscriber-mgmt local-user-db named-item ipoe host named-item ipv4 address pool
	Tree	pool
	Notes	The following elements are part of a choice: gi-address, ip-address, pool, or use-pool-from-client.
	Introduced	25.3.R2
	Platforms	7705 SAR Gen 2

delimiter string


	Synopsis	Delimiter separating primary and secondary pool names
	Context	configure subscriber-mgmt local-user-db named-item ipoe host named-item ipv4 address pool delimiter string
	Tree	delimiter
	String length	1
	Introduced	25.3.R2
	Platforms	7705 SAR Gen 2

primary named-item


	Synopsis	Primary pool name
	Context	configure subscriber-mgmt local-user-db named-item ipoe host named-item ipv4 address pool primary named-item
	Tree	primary
	String length	1 to 32
	Notes	This element is mandatory.
	Introduced	25.3.R2
	Platforms	7705 SAR Gen 2

secondary named-item


	Synopsis	Secondary pool name
	Context	configure subscriber-mgmt local-user-db named-item ipoe host named-item ipv4 address pool secondary named-item
	Tree	secondary
	String length	1 to 32
	Introduced	25.3.R2
	Platforms	7705 SAR Gen 2

use-pool-from-client


	Synopsis	Enable the use-pool-from-client context
	Context	configure subscriber-mgmt local-user-db named-item ipoe host named-item ipv4 address use-pool-from-client
	Tree	use-pool-from-client
	Notes	The following elements are part of a choice: gi-address, ip-address, pool, or use-pool-from-client.
	Introduced	25.3.R2
	Platforms	7705 SAR Gen 2

delimiter string


	Synopsis	Delimiter character to combine primary and secondary pool names
	Context	configure subscriber-mgmt local-user-db named-item ipoe host named-item ipv4 address use-pool-from-client delimiter string
	Tree	delimiter
	String length	1
	Introduced	25.3.R2
	Platforms	7705 SAR Gen 2

gi-address ipv4-unicast-address


	Synopsis	GI addresses based on the host entry in the LUDB
	Context	configure subscriber-mgmt local-user-db named-item ipoe host named-item ipv4 gi-address ipv4-unicast-address
	Tree	gi-address
	Introduced	25.3.R2
	Platforms	7705 SAR Gen 2

option [number] (number | keyword)


	Synopsis	Enter the option list instance
	Context	configure subscriber-mgmt local-user-db named-item ipoe host named-item ipv4 option (number \| keyword)
	Tree	option
	Introduced	25.3.R2
	Platforms	7705 SAR Gen 2

[number] (number | keyword)


	Synopsis	DHCP option to send identification strings to client
	Context	configure subscriber-mgmt local-user-db named-item ipoe host named-item ipv4 option (number \| keyword)
	Tree	option
	Range	1 to 254
	Options	subnet-mask, default-router, dns-server, domain-name, netbios-name-server, netbios-node-type, lease-time, lease-renew-time, lease-rebind-time
	Notes	This element is part of a list key.
	Introduced	25.3.R2
	Platforms	7705 SAR Gen 2

ascii-string string-not-all-spaces


	Synopsis	DHCP option specified as an ASCII string
	Context	configure subscriber-mgmt local-user-db named-item ipoe host named-item ipv4 option (number \| keyword) ascii-string string-not-all-spaces
	Tree	ascii-string
	String length	1 to 127
	Notes	The following elements are part of a mandatory choice: ascii-string, duration, empty, hex-string, ipv4-address, or netbios-node-type.
	Introduced	25.3.R2
	Platforms	7705 SAR Gen 2

duration number


	Synopsis	DHCP option as time duration
	Context	configure subscriber-mgmt local-user-db named-item ipoe host named-item ipv4 option (number \| keyword) duration number
	Tree	duration
	Range	10 to 315446399
	Units	seconds
	Notes	The following elements are part of a mandatory choice: ascii-string, duration, empty, hex-string, ipv4-address, or netbios-node-type.
	Introduced	25.3.R2
	Platforms	7705 SAR Gen 2

empty


	Synopsis	Remove DHCP option configuration
	Context	configure subscriber-mgmt local-user-db named-item ipoe host named-item ipv4 option (number \| keyword) empty
	Tree	empty
	Notes	The following elements are part of a mandatory choice: ascii-string, duration, empty, hex-string, ipv4-address, or netbios-node-type.
	Introduced	25.3.R2
	Platforms	7705 SAR Gen 2

hex-string hex-string


	Synopsis	DHCP option specified as hexadecimal string
	Context	configure subscriber-mgmt local-user-db named-item ipoe host named-item ipv4 option (number \| keyword) hex-string hex-string
	Tree	hex-string
	String length	1 to 256
	Notes	The following elements are part of a mandatory choice: ascii-string, duration, empty, hex-string, ipv4-address, or netbios-node-type.
	Introduced	25.3.R2
	Platforms	7705 SAR Gen 2

ipv4-address ipv4-address


	Synopsis	DHCP option as a list of IPv4 addresses
	Context	configure subscriber-mgmt local-user-db named-item ipoe host named-item ipv4 option (number \| keyword) ipv4-address ipv4-address
	Tree	ipv4-address
	Max. instances	4
	Notes	The following elements are part of a mandatory choice: ascii-string, duration, empty, hex-string, ipv4-address, or netbios-node-type. This element is ordered by the user.
	Introduced	25.3.R2
	Platforms	7705 SAR Gen 2

netbios-node-type keyword


	Synopsis	DHCP option as NetBIOS node type
	Context	configure subscriber-mgmt local-user-db named-item ipoe host named-item ipv4 option (number \| keyword) netbios-node-type keyword
	Tree	netbios-node-type
	Options	b-node, p-node, m-node, h-node
	Notes	The following elements are part of a mandatory choice: ascii-string, duration, empty, hex-string, ipv4-address, or netbios-node-type.
	Introduced	25.3.R2
	Platforms	7705 SAR Gen 2

mask type keyword


	Synopsis	Enter the mask list instance
	Context	configure subscriber-mgmt local-user-db named-item ipoe mask type keyword
	Tree	mask
	Introduced	25.3.R2
	Platforms	7705 SAR Gen 2

type keyword


	Synopsis	Matching type to identify a host
	Context	configure subscriber-mgmt local-user-db named-item ipoe mask type keyword
	Tree	mask
	Description	This command configures the data type that represents the type of matching performed to identify a DHCP host.
	Options	circuit-id, remote-id, sap-id, string, system-id, option60, duid-en, duid-ll-llt
	Notes	This element is part of a list key.
	Introduced	25.3.R2
	Platforms	7705 SAR Gen 2

prefix


	Synopsis	Enable the prefix context
	Context	configure subscriber-mgmt local-user-db named-item ipoe mask type keyword prefix
	Tree	prefix
	Introduced	25.3.R2
	Platforms	7705 SAR Gen 2

length number


	Synopsis	PPP mask prefix length
	Context	configure subscriber-mgmt local-user-db named-item ipoe mask type keyword prefix length number
	Tree	length
	Range	1 to 127
	Notes	The following elements are part of a mandatory choice: length or string.
	Introduced	25.3.R2
	Platforms	7705 SAR Gen 2

string string


	Synopsis	Prefix string
	Context	configure subscriber-mgmt local-user-db named-item ipoe mask type keyword prefix string string
	Tree	string
	String length	1 to 127
	Notes	The following elements are part of a mandatory choice: length or string.
	Introduced	25.3.R2
	Platforms	7705 SAR Gen 2

suffix


	Synopsis	Enable the suffix context
	Context	configure subscriber-mgmt local-user-db named-item ipoe mask type keyword suffix
	Tree	suffix
	Introduced	25.3.R2
	Platforms	7705 SAR Gen 2

length number


	Synopsis	PPP mask suffix length
	Context	configure subscriber-mgmt local-user-db named-item ipoe mask type keyword suffix length number
	Tree	length
	Range	1 to 127
	Notes	The following elements are part of a mandatory choice: length or string.
	Introduced	25.3.R2
	Platforms	7705 SAR Gen 2

string string


	Synopsis	Suffix substring
	Context	configure subscriber-mgmt local-user-db named-item ipoe mask type keyword suffix string string
	Tree	string
	Description	This command specifies a substring that is stripped off the end of the incoming circuit ID before it is matched against the value configured in the circuit ID.
	String length	1 to 127
	Notes	The following elements are part of a mandatory choice: length or string.
	Introduced	25.3.R2
	Platforms	7705 SAR Gen 2

match-list keyword


WARNING: Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.
	Synopsis	IPoE host match type
	Context	configure subscriber-mgmt local-user-db named-item ipoe match-list keyword
	Tree	match-list
	Description	This command specifies the type of matching done to identify a host. There are different match-types for IPoE hosts.
	Options	circuit-id, mac, remote-id, sap-id, service-id, string, system-id, option60, encap-tag-range, dual-stack-remote-id, derived-id, ip, encap-tag-separate-range, duid-en, duid-ll-llt
	Max. instances	4
	Notes	This element is ordered by the user.
	Introduced	25.3.R2
	Platforms	7705 SAR Gen 2

rip-policy [name] named-item


	Synopsis	Enter the rip-policy list instance
	Context	configure subscriber-mgmt rip-policy named-item
	Tree	rip-policy
	Max. instances	255
	Introduced	25.3.R2
	Platforms	7705 SAR Gen 2

[name] named-item


	Synopsis	RIP policy name
	Context	configure subscriber-mgmt rip-policy named-item
	Tree	rip-policy
	String length	1 to 32
	Notes	This element is part of a list key.
	Introduced	25.3.R2
	Platforms	7705 SAR Gen 2

authentication-key encrypted-leaf


	Synopsis	Authentication key
	Context	configure subscriber-mgmt rip-policy named-item authentication-key encrypted-leaf
	Tree	authentication-key
	String length	1 to 51
	Introduced	25.3.R2
	Platforms	7705 SAR Gen 2

authentication-type keyword


	Synopsis	Authentication type used between RIP neighbors
	Context	configure subscriber-mgmt rip-policy named-item authentication-type keyword
	Tree	authentication-type
	Options	password, message-digest, message-digest-20
	Introduced	25.3.R2
	Platforms	7705 SAR Gen 2

description description


	Synopsis	Text description
	Context	configure subscriber-mgmt rip-policy named-item description description
	Tree	description
	String length	1 to 80
	Introduced	25.3.R2
	Platforms	7705 SAR Gen 2