vpn (nrcmd)						vpn (nrcmd)


NAME
    vpn - Defines a logical VPN within which other DHCP objects
    may be configured

    Note: The namespace command is a synonym for compatibility
    with earlier versions of Network Registrar.

SYNOPSIS
    vpn <name> create <id-value> [<attribute>=<value> ...]
    vpn <name> delete 
    vpn list
    vpn listnames
    vpn <name> show

    vpn <name> get <attribute>
    vpn <name> set <attribute>=<value> [<attribute>=<value> ...]
    vpn <name> unset <attribute>
    
DESCRIPTION
    The vpn commands manipulate VPN objects in the DHCP server
    configuration. Each VPN must have a unique ID value.
    Other objects are associated with (or placed into) a VPN by
    VPN id. 

    Note: The reserved names "global" and "all" cannot be used
    as VPN names. These reserved names are used by other commands that
    take vpn names as arguments.

    In contrast to most other CLI configuration objects, you can
    change the name of a VPN.  The ID of the VPN, however, cannot
    be changed.  Both the name and ID of the VPN must be unique
    upon creation.

EXAMPLES
    nrcmd> vpn red show

    nrcmd> vpn red set vpn-id=23:456 
 
STATUS

SEE ALSO

PROPERTIES
  Attributes:

    addr-blocks-default-selection-tags[9] (AT_ARRAY(AT_STRING), Optional, default: <none>)
        Specifies the default selection tag (or list of tags) that will
        be associated with incoming subnet-allocation requests in this
        vpn that do not contain any subnet name data. No
        default.

    addr-blocks-use-client-affinity[7] (AT_BOOL, Optional, default: <none>)
        Determines whether the DHCP server attempts to allocate
        subnets to clients using address-blocks that the clients
        have already used. Default is true (enable).
        If you disable this attribute, the server then supplies
        subnets from any block that is suitable, based on other
        selection data in the clients' messages.

    addr-blocks-use-lan-segments[6] (AT_BOOL, Optional, default: <none>)
        Controls whether DHCP subnet-allocation uses the
        lan-segment attribute when configured on address-blocks.

    addr-blocks-use-selection-tags[8] (AT_BOOL, Optional, default: <none>)
        Controls whether the server compares the subnet name data in
        incoming subnet-allocation requests with each address-block's
        selection tags. A block will only be considered if the
        two match. No default.

    description[5] (AT_STRING, Optional, default: <none>)
        Describes the VPN that this  object represents.

    id[4] (AT_INT, Required, default: <none>)
        The VPN's unique id.  This is a 32 bit value that is associated
        with every VPN-qualified IP address, subnet or address block.
        It is different than and unrelated to the standard 7-byte VPN-ID.

    name[1] (AT_STRING, Required, default: <none>)
        The VPN's name within the CNR management system. Independent from,
        but could be the same as the vrf-name.

    vpn-id[2] (AT_VPNID, Optional, default: <none>)
        The vpn-id in RFC 2685 format (i.e, 7 octets),
        using a syntax similar to that used by IOS to enter the
        same information.  The syntax is 3 hex octets, a colon,
        and 4 hex octets.  For example 010203:04050607 would
        be the way to enter the following hex octets:
        01:02:03:04:05:06:07 into this property.

    vrf-name[3] (AT_STRING, Optional, default: <none>)
        The VPN's VRF name.

