subnet (nrcmd)						subnet (nrcmd)


NAME
    subnet - Describes a contiguous range of IP address space
    in the address-space model

SYNOPSIS
    subnet <address/mask> create
    subnet <address> delete 
    subnet list
    subnet listnames
    subnet <address> show
    
    subnet <address> get <attribute>
    subnet <address> set <attribute>=<value> [<attribute>=<value> ...]
    subnet <address> unset <attribute>

DESCRIPTION

    A subnet is a correctly aligned, power-of-2 sized sequence of IP
    addresses.  In the address space model, subnets are leaf nodes
    while address-blocks are root, internal or leaf nodes of a tree
    describing the address space.

EXAMPLES
    nrcmd> subnet 192.168.0.0 create 
    nrcmd> subnet 192.168.0.64 set primary-subnet=192.168.0.0
    nrcmd> subnet 192.168.0.64 show primary-subnet
STATUS

SEE ALSO
    address-block

PROPERTIES
  Attributes:

    address[2] (AT_SUBNET, Required, default: <none>)
        Sets the subnet address for this subnet. Stored as a network
        address and a mask determining how large the range is.

    description[13] (AT_STRING, Optional, default: <none>)
        Provides a description of this subnet.

    dns-host-bytes[22] (AT_RANGEINT(1-4), Optional, default: <none>)
        Determines the correct in-addr.arpa name to create, when
        creating reverse zones from a subnet.  Based on this value
        and the subnet size, either a new reverse zone is created,
        or delegation records are put into the parent reverse zone.
        If unset, the server synthesizes an appropriate value based on
        the subnet size. This value parallels the dns-host-bytes
        attribute in the Scope class.

    failoverpair[11] (AT_OID, Optional, default: <none>)
        For DHCP allocation, assigns a subnet to a CCMFailoverPair
        or to a single CCMCluster object.

    forward-zone-name[19] (AT_DNSNAME, Optional, default: <none>)
        Names the forward zone associated with this subnet.

    interface[8] (AT_OID, Optional, default: <none>)
        Assigns a subnet to a router interface.

    owner[6] (AT_OID, Optional, default: <none>)
        Identifies the owner of this object, referenced by OID.  Use the
        owner field to group similarly owned objects and to limit access
        to objects by their owner.
        If this attribute is unset, the object is assumed to have the
        same owner as its parent.

    parent[1] (AT_OID, Optional, default: <none>)
        Identifies the parent address block for this subnet.

    primary-subnet[21] (AT_SUBNET, Optional, default: <none>)
        Contains the subnet number of a subnet's primary subnet. Use
        this attribute when multiple logical IP subnets are present
        on the same physical network.

    region[5] (AT_OID, Optional, default: <none>)
        Associates an object with a region. The object is referenced by
        OID.  Use the region field to group similarly located objects
        to limit access to objects by their region.
        If this attribute is unset, the object is assumed to have the
        same region as its parent.

    reverse-zone-name[20] (AT_DNSNAME, Optional, default: <none>)
        Names the reverse zone associated with this subnet.

    subnet-state[23] (AT_FLAGSINT(), Optional, default: )
        Shows the current state of this subnet.

    type[4] (AT_NAMEREF(1446), Optional, default: <none>)
        Identifies the type of this subnet.  This attribute contains the
        name of a CCMAddrSpaceType object that contains more information
        about the type.
        If this attribute is unset, the object is assumed to have the
        same type as its parent.

    vpn-id[3] (AT_INT, Optional, default: 0)
        Specifies the  VPN that contains the subnet address for this
        subnet.

