SaMOG Service Configuration Mode Commands

Mode

Creates SaMOG service and enters SaMOG service configuration mode.

Exec > Global Configuration > Context Configuration > SAMOG Service Configuration

configure > context context_name > samog-service samog_service_name

Entering the above command sequence results in the following prompt: 

[context_name]host_name(config-samog-service)#

Important

Available commands or keywords/variables vary based on platform type, product version, and installed license(s).

associate

SaMOG associates another service to this SAMOG service.

Product

SaMOG

Mode

Exec > Global Configuration > Context Configuration > SAMOG Service Configuration

configure > context context_name > samog-service samog_service_name

Entering the above command sequence results in the following prompt: 

[context_name]host_name(config-samog-service)#

Syntax

associate { apgroupname-list aplistname1  reject-call cgw-service cgw_service_name | dhcp-service dhcp_service_name [ level { system | user } ] | dhcpv6-service dhcpv6_service_name| mrme-service mrme_service_name | subscriber-map subscriber_map_name } 
 no  associate {  apgroupname-list reject-call cgw-service | dhcp-service | dhcpv6-service | mrme-service | subscriber-map }

no

Disables the association of the service with the SaMOG service.

The no associate dhcp-service command does not disassociate existing sessions, and only new sessions will not be established. Existing sessions continue to use the DHCPv4 service to which it was bound during session establishment.

The no associate dhcpv6-service command stops the SaMOG service from processing DHCPv6 packets.

cgw-service cgw_service_name

The CGW service should be configured before associating the same with SaMOG service.

cgw_service_name must be an alphanumeric string between 1 and 63 characters.

dhcp-service dhcp_service_name [ level { system | user } ]

Specifies the DHCPv4 service to associate with the SaMOG service. DHCPv4 is optional while starting an SaMOG service.

dhcp_service_name must be an alphanumeric string from 1 through 63.

While the association of the DHCPv4 service with the SaMOG service is optional, DHCPv4 service must be associated with the SaMOG service for the SaMOG Ethernet over GRE (EoGRE) feature to function. If no DHCPv4 service is configured and associated, and at least one EoGRE access type Radius client exist, the output of the show configuration errors command will display a warning under the SaMOG service system errors section.


Important

The associated DHCPv4 service must not be used for any service other than SaMOG, as packets are always forwarded over the EoGRE tunnel only.

level { system | user } : Specifies the processing level of the DHCP server messages. system will enable DHCP server messages to be processed at the system and user-level. user will enable DHCP server messages to be processed at the user-level only. The default value for processing DHCP messages is user level.

dhcpv6-service dhcpv6_service_name

Specifies the DHCPv6 service to associate with the SaMOG service, to process DHCPv6 packets. Configure the DHCPv6 server using the bind address command in the DHCPv6 Service Configuration Mode.

dhcpv6_service_name must be an alphanumeric string from 1 through 63 characters.

mrme-service mrme_service_name

The MRME service should be configured before associating the same with SaMOG service.

mrme_service_name must be an alphanumeric string from 1 through 63 characters.

subscriber-map subscriber_map_name

The subscriber map service should be configured before associating the same with SaMOG service.

subscriber_map_name must be an alphanumeric string from 1 through 63 characters.

associate apgroupname-list

Associates the configured apgroupname-list with samog-service.

no associate apgroupname-list reject-call

Dis-associates APGROUPNAME list from the SaMOG and all the AP group names present in the list are allowed to establish session.

Usage Guidelines

Use this command to associate the SaMOG service to CGW service, DHCPv4 service, MRME service, or Subscriber Mapping.

Example

The following command associates subscriber-map smap with SaMOG Service. 

associate subscriber-map smap

The following command associates cgw-service cgw with SaMOG Service. 

associate cgw-service cgw

The following command associates mrme-service mrme with SaMOG Service. 

associate mrme-service mrme

do show

Executes all show commands while in Configuration mode.

Product

All

Privilege

Security Administrator, Administrator

Syntax

do show

Usage Guidelines

Use this command to run all Exec mode show commands while in Configuration mode. It is not necessary to exit the Config mode to run a show command.

The pipe character | is only available if the command is valid in the Exec mode.


Caution

There are some Exec mode show commands which are too resource intensive to run from Config mode. These include: do show support collection , do show support details , do show support record and do show support summary . If there is a restriction on a specific show command, the following error message is displayed: 

Failure: Cannot execute 'do	show support' command from Config mode.

end

Exits the current configuration mode and returns to the Exec mode.

Product

All

Privilege

Security Administrator, Administrator

Syntax

end

Usage Guidelines

Use this command to return to the Exec mode.

exit

Exits the current mode and returns to the parent configuration mode.

Product

All

Privilege

Security Administrator, Administrator

Syntax

exit

Usage Guidelines

Use this command to return to the parent configuration mode.

max-sessions

Configures maximum number of subscribers SAMOG service can support, ranging from 0 to 4000000.

Product

All

Privilege

Security Administrator, Administrator

Mode

Exec > Global Configuration > Context Configuration > SAMOG Service Configuration

configure > context context_name > samog-service samog_service_name

Entering the above command sequence results in the following prompt: 

[context_name]host_name(config-samog-service)#

Syntax

max-sessions max_sessions  
default max-sessions

max-sessions max_sessions

Configures maximum number of subscribers SAMOG service can support.

max_sessions is an integer value between 0 and 4000000 .

default

Sets the default value, 4000000 for Max Sessions.

Usage Guidelines

Use this command to configure the maximum number of subscribers SAMOG service can support.

Example

Use the following command to configure the maximum number of subscribers SAMOG service can support: 

max-sessions 500

reporting-action

Configures reporting of events.

Product

SaMOG

Privilege

Security Administrator, Administrator

Mode

Exec > Global Configuration > Context Configuration > SAMOG Service Configuration

configure > context context_name > samog-service samog_service_name

Entering the above command sequence results in the following prompt: 

[local]host_name(config-samog-service)#

Syntax

[ no ] reporting-action event-record

no

Disables RTT record generation for this SaMOG service.

event-record

Configures event records.

Usage

Use this command to configure the reporting of events for the SaMOG service.

Example

The following command configures the reporting of event records: 
reporting-action event-record

timeout

Configures the session's time-to-live (TTL) settings under SAMOG service.

Product

All

Privilege

Security Administrator, Administrator

Mode

Exec > Global Configuration > Context Configuration > SAMOG Service Configuration

configure > context context_name > samog-service samog_service_name

Entering the above command sequence results in the following prompt: 

[context_name]host_name(config-samog-service)#

Syntax

timeout { absolute absolute_value  | idle idle_value | setup-timeout setup_timeout_value } 
default timeout [ absolute | idle | setup-timeout ] 
no timeout [ absolute | idle ]

default

Sets/restores the default value assigned for timeout.

The default value of absolute and idle timeout is 0 , which indicates the function is disabled.

The default value of setup-timeout is 60 .

no

Enables / Disables the timeout option.

absolute absolute_value

Specifies the maximum duration of the session, in seconds, before the system automatically terminates the session.

absolute_value must be an integer between 0 and 2147483647 .

idle idle_value

Specifies the maximum duration a session can remain idle, in seconds, before the system automatically terminates the session. Zero indicates that the timeout function is disabled. Default is 0 .

idle_value must be an integer between 0 and 2147483647 .

setup-timeout setup_timeout_value

Specifies the maximum time allowed for session setup in seconds. Default is 60 seconds.

setup_timeout_value must be an integer between 0 and 1000000 .

Usage Guidelines

Use this command to configure the session's time-to-live (TTL) settings under SAMOG service.

Example

Use the following command to configure the setup-timeout to 500 seconds: 

timeout setup-timeout 500

Use the following command to configure the absolute timeout to 120 seconds: 

timeout absolute 120