lease-notification (nrcmd)              lease-notification (nrcmd)


NAME
    lease-notification - Reports scopes with few free leases

SYNOPSIS
    lease-notification available=<number>|<percentage>
                       [config=config file>]
                       [leasing-only]
                       [scopes=<scope name>|<address range>
                        [,<scope name>|<address range>,...]]
                       [[recipients=<recipient>[,<recipient>,...]]
                        [mail-host=<name> [errors-to=<recipient>]] ]
		       [vpn=<vpn-name>] 


DESCRIPTION
    Use the lease-notification command to receive notification
    about the number of available addresses in a scope. This 
    command reports on the scopes for which the number of
    available addresses falls below or equals a set value. You
    can specify the notification limit either as the number of
    free addresses or the percentage of free addresses. You can
    also specify who should receive e-mail notification.    

    Although you can use the lease-notification command interactively,
    its primary use is as an automated command. 
    
       You can specify clusters in several ways:

       -  The default cluster (localhost)

       -  The AIC_CLUSTER environment variable or NT registry entry

       -  The -C flag on the command line

       -  The clusters property in the config file lets you specify
       a group of clusters. For example, to specify several clusters,
       enter the following in the config file:

          # Cluster information for summary reports
           [lease-notification]
          # Clustername Username Password
           clusters=host1 admin passwd1, host2 admin2,host3,
                 host4 admin4 passwd4

        Follow these guidelines for specifying clusters:
          - Separate cluster specifications from each other with commas.
          - Separate arguments for a particular cluster by whitespace.
          - For long lines use continuation lines; you do not continuation 
            escape indicators.  
          - Optionally, specify a user name and password for the cluster.
            If you do not provide a user name or password for a particular
            cluster, Network Registrar uses the last user name or
            password listed. If you do not provide user names or passwords,
            Network Registrar uses the information from the command line
            -N and -P arguments, and then the NT Registry or environment
            variables AIC_NAME and AIC_PASSWORD.  If Network Registrar
            cannot find a user name or password, or the supplied user name
            and password are incorrect, the lease-notification command
            issues a warning for that cluster.

    The lease-notification command output consists of an explanatory header, 
    a table containing a row for each scope in which the number of 
    free addresses is equal to or less than the threshold, and possible 
    warnings related to the scopes and clusters requested.  
  
    The lease-notification command reports the following information
    for each scope in the table:
    
    -  Cluster name
    -  Scope name
    -  Scope network address in the canonical dotted format
    -  Number of high-order bits in the scope subnet mask
    -  Number of addresses in the scope ranges
    -  Percentage of addresses available for lease
    -  Number of addresses available for lease (addresses that 
       are reserved or deactivated are not included as free)

LEASE NOTIFICATION KEYWORDS

    available 
        Specifies either a number or percentage of available addresses.
        If the number or percentage of available addresses is equal to
        or less than the specified value for the scopes being checked,
        Network Registrar generates a report listing information about
        the scopes that reach or exceed the available value.

    config
        Specifies a configuration file. If you don't specify a configur-
        ation file, Network Registrar searches for the default .nrconfig
        file. 

    errors-to
        If you specify a mail-host, you may also specify the email
        address of the sender of the email in order to provide a return
        path for bounced email.  The default value is "postmaster".

    leasing-only
        Specifies that only scopes that can currently offer leases
        are reported.

    mail-host
        On NT, you must specify a mail-host. On Solaris the mail
        host is generally already configured for the sendmail program.
        You can verify that your Solaris system is properly configured
        by issuing the command "date | mail <your-email-address>" and
        observing whether or not the date is emailed to you.

    recipients
        If you specify the email addresses of one or more recipients,
        Network Registrar sends an email report to those addresses.
        Otherwise, Network Registrar directs the report to standard
        output.

    scopes
        The scopes to check either by name or as a range or ranges of
        addresses. Network Registrar checks any scope containing any
        address that falls with in a range of address. If you don't
        list any scopes or addresses, Network Registrar checks all
        scopes managed by the specified cluster.

    vpn
	The VPN from which to select scopes to examine when executing
	this command.  If no VPN name is specified, then the
	current VPN of the session is used.  If the reserved VPN name
	"global" is used, then the global (or unnamed) VPN is used.
	If the reserved VPN name "all" is used, then all scopes from
	all vpns are examined.

EXAMPLES

STATUS

SEE ALSO
    report, export addresses, session current-vpn

PROPERTIES

