session (nrcmd)					session (nrcmd)


NAME
    session - Configures nrcmd program session parameters

SYNOPSIS
    session set <attribute>=<value>
    session get <attribute>
    session enable <attribute>
    session disable <attribute>
    session show

    session cache <refresh | clear>

    session listNetInterfaces
    
    session log [<filename>]

DESCRIPTION
    The session command lets you view and set session parameters,
    such as the session visibility and the default output
    format of your nrcmd program session.

    The listNetInterfaces command returns a list of the network
    interfaces that are present on the machine running 
    Network Registrar. Both IPv4 and IPv6 interfaces are included.
    
    The log command closes the currently open log file, if any,
    and opens a new log file to which subsequent output is written
    if a filename is specified.

PROPERTIES

FEATURES
	
    cache
       The CLI caches many configuration objects that it reads. If
	 multiple users are making changes simultaneously, one CLI
	 instance may have cached an out-of-date version of an object.
	 The cache refresh command causes the CLI to clear its local
	 cache of all unmodified objects, forcing the CLI to re-read
	 objects from the configuration database. The cache clear 
       command forces the CLI to clear all cached data, whether or
       not unsaved changes have been made.

    cluster
       The name of the current cluster.  This is a read-only property.
 
    current-vpn (or current-namespace)
	 The name of the current VPN presently in effect.  This is a
	 read/write property.  This is the VPN used in commands which
	 need a VPN (e.g., lease, report, export) and no VPN is
	 explicitly specified when the command is issued. The reserved
	 vpn-name "global" is the VPN which contains all of the IP
	 addresses not in any explicitly named VPN, and is the default
	 current-vpn for the session.
	
	 Note: If the session is interactive, the nrcmd> prompt
	 is changed to nrcmd [VPN=<vpn-name>]> except when the
	 current-vpn is global.

    default-format
       The default-format is an enumerated string that can have
       the following settings.  If not set, it is interpreted as
       script.

          user - Show objects in user-friendly form: one property
          per line.
    
          script - Show objects in script friendly form: one object
          per line.
          
    error
       The error detail for the last request to the CCM server that 
       failed. This report is often used to get more detailed information
       about why a nrcmd command failed to complete successfully.
        
       Note: The error detail may not reflect the final result of the 
       nrcmd command because some commands result in multiple requests
       to CCM, one or more of which may have failed and the error detail
       reports only on the last failed operation (which may not be the
       last operation).

    groups
       Displays the list of groups associated with the current user.

    roles
       Displays the list of roles associated with the current user.

    scope-edit-mode
       The edit mode currently in effect when editing DHCP scopes. The
	 valid values are 'staged' and 'synchronous' (or 'sync'). The value
	 'default' will use the value configured at the CCM server.
	 This feature only appears in Network Registrar 6.2 and later releases.

    user-name
       The name of the current user.  This is a read-only property.

    version
       Retrieves the version associated with the Network Registrar
       cluster.
        
    visibility
       The session visibility setting. The default level is 5, which is
       the normal operating mode. Visibility level 3 can be set to view
       'expert' level properties. These additional, reserved properties 
       should be modified with caution. Incorrect settings for these 
       properties can result in network outages. The default settings 
       are the best choice in virtually all cases and should not be 
       changed, except to address a specific network issue. Changes 
       should not be attempted without assistance from the Cisco TAC.

    zone-edit-mode
       The edit mode currently in effect when editing CNR zones. The
	 valid values are 'staged' and 'synchronous' (or 'sync'). The value
	 'default' will use the value configured at the CCM server.
	 This only appears for CNR 6.2 and later releases.

    
EXAMPLES
    
STATUS

SEE ALSO

