scope-template (nrcmd)				   scope-template (nrcmd)


NAME
    scope-template - Configures a scope template

SYNOPSIS
    scope-template <name> create [<attribute>=<value> ...]
    scope-template <name> delete
    scope-template <name> set <attribute>=<value> [<attribute>=<value> ...]
    scope-template <name> get <attribute>
    scope-template <name> unset <attribute>

    scope-template <name> disable <attribute>
    scope-template <name> enable <attribute>
    scope-template <name> show

    scope-template <name> create clone=<clone-name>
    scope-template <name> apply-to <all | <scope1>[,...]>

DESCRIPTION
    The scope-template command lets you configure a template to use
    when creating scopes.

EXAMPLES
    nrcmd> scope-template scope-example create<</b>

    nrcmd> scope-template scope-example set backup-pct=30<</b>

    nrcmd> scope-template scope-example enable allocate-first-available

STATUS

SEE ALSO
    scope

PROPERTIES
  Attributes:

    allocate-first-available[86] (AT_BOOL, Optional, default: <none>)
        This boolean attribute forces all allocation of new IP addresses from
        this scope to be made from the first available IP address, rather than
        the default of the "least recently used" IP address.
        If this attribute is not set (unset), then the decision on whether to
        allocate the first available IP address in the scope will be
        controlled by the DHCP server attribute priority-address-allocation.
        If priority-address-allocation is set (and allocate-first-available
        for the scope is not set (unset)), then the scope will allocate
        addresses as if allocate-first-available was set.  If
        allocate-first-available has been explicitly configured (either
        enabled or disabled) for a scope, then for that scope the setting of
        priority-address-allocation has no meaning.

    allocation-priority[85] (AT_INT, Optional, default: <none>)
        You can use the allocation-priority to assign an ordering to scopes,
        such that allocation of IP addresses will take place from acceptable
        scopes with a higher priority until the IP addresses in all those
        scopes are exhausted.  An allocation-priority of 0 is treated as not
        having an allocation-proiority.  You can mix scopes with an
        allocation-priority along with those without an allocation-priority
        (or with an allocation-priority of 0, which is the same thing) in the
        same network.  In this case, the scopes with an allocation priority
        will be examined for acceptability prior to those scopes with no
        allocation-priority (or an allocation-priority of 0).
        If this attribute is not set (unset), then the allocation-priority of
        the scope will be controlled by the DHCP server attribute
        priority-address-allocation.  If priority-address-allocation is set
        (and allocation-priority for the scope is not set (unset)), then the
        allocation-priority for the scope will be the network number of the
        scope.  If allocation-priority has been explicitly configured for a
        scope, then for that scope the setting of priority-address-allocation
        has no meaning.

    backup-pct[90] (AT_PERCENT, Optional, default: <none>)
        The percentage of available addresses that the main server
        should send to the backup server.  If defined for a scope, it
        must be defined for the scope in the main server.  If it is
        defined in a backup server, it is ignored (to enable copying
        of configurations).  If it is defined, the defined value will
        override the failover pair's defined values for backup-pct
        and dynamic-bootp-backup-pct, and the value defined here is
        the value that will be used for this scope, whether or not
        this scope supports dynamic-bootp.  If it is set to zero (0),
        no addresses will be sent to the backup server.  Since zero
        is a significant value, once set, this parameter must be
        unset in order for this scope to utilize 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 percentage is ignored and 50% is used.

    bootp[21] (AT_BOOL, Optional, default: <none>)
        Controls whether the server will accept BOOTP requests
        for this scope. If you want clients to always receive the
        same addresses, you need to reserve IP addresses for all your
        BOOTP clients.

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

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

    dhcp[38] (AT_BOOL, Optional, default: <none>)
        Controls whether the server will accept DHCP requests
        for this scope. Typically, this is only disabled when
        bootp is enabled for that scope, to allow only a scope
        to be used exclusively for BOOTP.

    dns-host-bytes[19] (AT_RANGEINT(1-4), Optional, default: <none>)
        This value tells DHCP how many of the bytes in a lease's 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 this is unset, the server will synthesize an appropriate value
        based on the scope's subnet size.

    dynamic-bootp[22] (AT_BOOL, Optional, default: <none>)
        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>)
        The embedded policy object for this scope.

    free-address-config[89] (AT_NAMEREF(AddrTrapConfig), Optional, default: <none>)
        The free-address trap configuration to use for this individual scope.

    grace-period[82] (AT_TIME, Optional, default: <none>)
        The length of time between the expiration of a lease and the time it
        is made available for re-assignment.

    ignore-declines[84] (AT_BOOL, Optional, default: <none>)
        This attribute controls whether the DHCP server will process a
        DHCPDECLINE request referencing an IP address in this scope.  If
        this attribute is enabled, then the DHCP server will ignore all
        declines which reference an IP address in this scope.  If this
        attribute is not set, the DHCP server will set to UNAVAILABLE
        every IP address which is referenced in a DHCPDECLINE message.
        The default value is false, so that DHCPDECLINE messages are
        processed normally, and the IP addresses referenced in these
        DHCPDECLINE messages are set to UNAVAILABLE.

    name[1] (AT_STRING, Required, default: <none>)
        The name of this scope template.

    offer-timeout[81] (AT_TIME, Optional, default: <none>)
        If the server offers a lease to a client, but the offer is not
        accepted, the server will wait the specified number of seconds before
        making the lease 'available' again.

    options-expr[79] (AT_EXPR, Optional, default: <none>)
        An expression to define the list of embedded policy options
        to be created for a scope object.

    ping-clients[11] (AT_BOOL, Optional, default: <none>)
        Controls whether the server should attempt to ping
        addresses before offering leases.

    ping-timeout[10] (AT_INT, Optional, default: <none>)
        The number of milliseconds the DHCP server should wait for ping
        responses.  If you make this value too large, you will slow down the
        lease offering processes. If you make this value too small, you will
        reduce the effectiveness of pinging addresses before offering them.

    policy[5] (AT_NAMEREF(Policy), Optional, default: default)
        The name of the policy associated with this scope.

    ranges-expr[80] (AT_EXPR, Optional, default: <none>)
        An expression to define the list of scope ranges to be created
        for a scope object.

    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 will 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 it).

    router-host[83] (AT_INT, Optional, default: <none>)
        This is use to create the ip address from the subnet to put it on the
        router interface because router interface does not take network id.
        It takes ipaddress and mask

    scope-description-expr[91] (AT_EXPR, Optional, default: <none>)
        Defines an AT_STRING expression to apply to the description
        on the scope object created when using the template.

    scope-name[74] (AT_EXPR, Optional, default: <none>)
        An expression to define the name of the scope object created
        when using the scope template.

    selection-tag-list[75] (AT_NLIST(AT_STRING), Optional, default: <none>)
        The list of selection tags to associate with a scope.

    update-dns-for-bootp[39] (AT_BOOL, Optional, default: <none>)
        If the server is replying to a BOOTP request, and is offering a lease
        from a Scope which is configured to perform DNS updates, it will check
        this property before beginning the DNS update. This feature allows
        an administrator to prevent DNS updates for BOOTP clients, while
        allowing updates for DHCP clients.
        'Update-dns-for-bootp' can be controlled globally with the 'server'
        command; that global command can be overridden by individual Scopes
        as necessary.

    vpn-id[68] (AT_INT, Optional, default: 0)
        The id of the dhcp vpn that contains this scope.  The
        vpn-id of a scope must be initialized when the scope
        is created, and cannot be edited once it is set.

