scope (nrcmd)						    scope (nrcmd)


NAME
    scope - Specifies the scope's properties

SYNOPSIS
    scope list
    scope listnames  
    scope <name> create <address> <mask> [template=<template-name>]
                        [<attribute>=<value>...]
    scope <name> delete 
    scope <name> set <attribute>=<value> [<attribute>=<value> ...]
    scope <name> get <attribute>
    scope <name> unset <attribute>
    scope <name> disable <attribute>
    scope <name> enable <attribute>
    scope <name> show

    scope <name> listLeases 

    scope <name> addRange <start> <end>
    scope <name> removeRange <start> <end>
    scope <name> listRanges

    scope <name> addReservation <ipaddr> (<macaddr>|<lookup-key>)
                                [-mac|-blob|-string]
    scope <name> removeReservation (<ipaddr>|<macaddr>|<lookup-key>)
                                   [-mac|-blob|-string]
    scope <name> listReservations 

    scope <name> changeMask  <mask>
    scope <name> clearUnavailable

    scope <name> applyTemplate <template-name>

DESCRIPTION
    The scope command lets you manipulate address ranges in the 
    DHCP server.
    
    When creating a scope using a template, specify - for the
    <name> to allow the scope template's scope-name to name 
    the scope.

    scope <name> listLeases     
       The listLeases command lists the leases associated
       with this scope.  
    
    scope <name> addRange <start> <end>
    scope <name> removeRange <start> <end>
    scope <name> listRanges
       The addRange command adds a range of available addresses 
       to the scope. The <start> and <end> values can either be
       full IP addresses or host numbers within the scope's 
       subnet.  It is an error if either <start> or <end> is 
       an IP address outside the scope's subnet or is a host
       number that exceeds the bits allocated to host numbers
       by the scope's netmask.
    
       The removeRange command removes a range of addresses from the
       scope's control.  
    
       The listRanges command lists the current ranges of addresses
       available for allocation.  
    
    scope <name> addReservation <ipaddr> (<macaddr>|<lookup-key>)
                                [-mac|-blob|-string]
    scope <name> removeReservation (<ipaddr>|<macaddr>|<lookup-key>)
                                   [-mac|-blob|-string]
    scope <name> listReservations
       The addReservation command adds a reservation for a 
       specific IP address to a specific MAC address or lookup 
       key.
    
       The removeReservation command removes the reservation for
       an IP address, MAC address, or lookup key.
    
       The listReservations command lists the available 
       reservations.
    
    scope <name> changeMask  <mask>  
       The changeMask command changes the scope's netmask.  It 
       also changes the primary-mask properties of any secondary 
       scopes. Warnings are issued if the netmask is "narrowed" 
       and any reservations or ranges fall outside the network 
       defined by the new mask and existing address.

    scope <name> clearUnavailable
       The clearUnavailable command moves all unavailable leases 
       in the specified scope to available.

    scope applyTemplate
       The applyTemplate command applies the specified 
       scope-template to the scope. All properties configured
       on the scope-template are applied to the scope.

    Note: The scope command manages a VPN through a virtual attribute:

       vpn [] (AT_STRING, Optional, default: <none>)
	
    Use this attribute to set or get the VPN ID by VPN name 
    instead of by ID.


EXAMPLES
    nrcmd> scope scope-example create 192.168.0.0 255.255.255.224 
    nrcmd> scope scope-example addRange 192.168.0.33 192.168.0.62 
    nrcmd> scope scope-example addReservation 192.168.0.40 00:d0:ba:d3:bd:3b 
    nrcmd> scope scope-example changeMask 255.255.255.192  

STATUS

SEE ALSO
    scope-template

PROPERTIES
  Attributes:

    allocate-first-available[81] (AT_BOOL, Optional, default: false)
        Enables you to force the allocation of new IP addresses
        from this scope to be the first available IP address;
        otherwise, the default of the 'least recently used' IP address is
        used.
        If this attribute is not set, or is unset, then the DHCP server
        attribute priority-address-allocation controls whether
        to allocate the first available IP address.
        If priority-address-allocation is set, and allocate-first-available
        for the scope is unset, then the scope allocates addresses as if
        allocate-first-available was set.
        If allocate-first-available is enabled or disabled for a scope, then
        for that scope the setting of priority-address-allocation has no
        meaning.

    allocation-priority[80] (AT_INT, Optional, default: 0)
        Assigns an order to scopes for allocating IP addresses. Acceptable
        scopes, with the highest allocation priority, grant IP addresses
        until the addresses are exhausted.
        You can mix scopes with an allocation-priority along with those
        without a priority in the same network.  In this case, scopes with
        allocation priorities are examined for acceptability before those
        scopes with no allocation-priority. Lower numeric values have
        higher priorities, but an allocation-priority of 0 (the default) has
        no priority.
        If this attribute is not set, or is unset or 0, then the
        DHCP priority-address-allocation attribute controls the priority
        of the scope. If the DHCP priority-address-allocation attribute is
        set, and allocation-priority for the scope is unset, then the
        allocation-priority for the scope is the network number of the
        scope.
        If you explicitly set allocation-priority, then, for that scope,
        the DHCP setting of priority-address-allocation has no meaning.

    backup-pct[89] (AT_PERCENT, Optional, default: <none>)
        Determines the percentage of available addresses that the main server
        sends to the backup server. If you define this value using the
        scope command, make sure you define it on the main server. If you
        define it on a backup server, it is ignored.
        Used with the scope command, the backup-pct attribute overrides
        the defined values on the failover pair for backup-pct and
        dynamic-bootp-backup-pct. The attribute value defined with the scope
        command becomes the value used for this scope, whether or not this
        scope supports dynamic-bootp.
        If you set the value to zero (0), the backup server receives no
        addresses. Since 0 is a significant value, once you set this value,
        you must unset it for the scope to use the failover pair's values for
        backup-pct or dynamic-bootp-backup-pct.
        Note: If the failover pair is configured to use load balancing, the
        backup-pct is ignored and 50% is used.

    bootp[21] (AT_BOOL, Optional, default: disabled)
        Controls whether the server accepts BOOTP requests. If you want
        clients to always receive the same addresses, you must reserve
        IP addresses for all your BOOTP clients.

    deactivated[36] (AT_BOOL, Optional, default: <none>)
        Controls whether a scope extends leases to any clients. A deactivated
        scope does not extend leases to any clients. It treats all addresses
        in its ranges as if they were individually deactivated.

    description[90] (AT_STRING, Optional, default: <none>)
        Describes the scope.

    dhcp[38] (AT_BOOL, Optional, default: enabled)
        Controls whether the DHCP server accepts DHCP requests for this
        scope. Disable DHCP if you want a scope to use BOOTP exclusively
        or you want to deactivate the scope temporarily.

    dns-host-bytes[19] (AT_RANGEINT(1-4), Optional, default: <none>)
        
        Tells DHCP how many bytes in a lease IP address to use when forming
        in-addr.arpa names. The server forms names in the in-addr zone by
        prepending dns-host-bytes of IP address (in reverse order) to the
        reverse zone name. If unset, the server synthesizes an appropriate
        value based on the scope's subnet size.

    dynamic-bootp[22] (AT_BOOL, Optional, default: disabled)
        Controls whether the server will accept dynamic BOOTP
        requests for this scope.  Dynamic BOOTP requests are BOOTP requests
        that do not match a reservation, but could be satisfied from the
        available lease pool. To use this feature you must also enable
        bootp.

    embedded-policy[59] (AT_OBJ, Optional, default: <none>)
        Displays the embedded policy for a scope.

    failover-backup-allocation-boundary[82] (AT_IPADDR, Optional, default: <none>)
        Sets the IP address allocation boundary for a backup server in a
        failover relationship.
        If the allocate-first-available attribute is set, the backup
        server allocates IP addresses in descending order from this
        boundary.
        If the allocate-first available attribute is unset or set to 0,
        the boundary used for allocating addresses is half the
        distance between the first and last IP address configured in the
        ranges for this scope.  If no IP addresses are available
        below this boundary, the first IP address available above this
        boundary is used.

    free-address-config[88] (AT_NAMEREF(AddrTrapConfig), Optional, default: <none>)
        Identifies which trap captures unexpected free address events
        on this scope.

    ignore-declines[79] (AT_BOOL, Optional, default: false)
        Determines whether the server reacts to server DHCPDECLINE
        messages that refer to one of the scope's IP addresses.
        If enabled (true), the DHCP server ignores all declines that
        refer to an IP address in this scope.  If disabled, the DHCP server
        sets to UNAVAILABLE every IP address referred to in this scope.
        Default is false (disabled).

    ping-clients[11] (AT_BOOL, Optional, default: disabled)
        Controls whether the server should attempt to ping an address
        before offering a lease. If enabled (true), this attribute also
        indicates a ping timeout.

    ping-timeout[10] (AT_INT, Optional, default: 300)
        Sets the number of milliseconds the DHCP server waits for ping
        responses.  If you make this value too large, you  slow down
        the lease offering processes. If you make this value too small,
        you reduce the effectiveness of pinging addresses before
        offering them. Three hundred milliseconds (the default value) is
        often the best choice.

    policy[5] (AT_NAMEREF(Policy), Required, default: default)
        Identifies the name of the policy associated with this scope. Default
        is the default policy.  This means that the scope uses all the
        properties set in the default policy (including the lease time),
        unless you specifically reset a property.

    primary-subnet[72] (AT_SUBNET, Optional, default: <none>)
        Determines the subnet address and mask of the primary scope.
        Use this attribute when multiple logical IP subnets are present
        on the same physical network.

    renew-only[33] (AT_BOOL, Optional, default: <none>)
        Controls whether to allow existing clients to reacquire their
        leases, but not offer any leases to new clients.  Note that a
        renew-only scope does not change the client associated with any
        of its leases (other than to allow a client, currently using what
        the server believes is an available IP address, to continue using
        the address).

    selection-tag-list[83] (AT_NLIST(AT_STRING), Optional, default: <none>)
        Associates a comma-separated list of selection tags with a
        scope. The scope compares a client's selection criteria to this
        list in order to determine whether the client can obtain a lease
        from the scope.

    subnet[69] (AT_SUBNET, Required, default: <none>)
        The network address of the IP subnet that this scope represents.

    vpn-id[68] (AT_INT, Optional, default: 0)
        Displays the identifier of the DHCP VPN that contains the addresses
        in this scope.  Define this value with  the vpn vpn-name create id
        command. Once set, you cannot change this value.

    