cluster (nrcmd)						    cluster (nrcmd)


NAME
    cluster - Configures the local and remote clusters

SYNOPSIS
    cluster <name> create <address> [<attribute>=<value>] 
    cluster <name> delete
    cluster list  
    cluster listnames
    cluster <name> show
    cluster <name> set <attribute>=<value> [<attribute>=<value> ...]
    cluster <name> get <attribute>
    cluster <name> unset <attribute>

    cluster <name> enable <attribute>
    cluster <name> disable <attribute>

DESCRIPTION
    The cluster command configures the specified local or remote 
    cluster, primarily providing connection and polling information;
    for example, IP address, fully qualified domain name, and HTTP port.  
    This information provides reference points for objects related to 
    the cluster.

EXAMPLES

STATUS

SEE ALSO

PROPERTIES
  Attributes:

    admin[4] (AT_STRING, Optional, default: <none>)
        Sets the administrator identity to use to contact this cluster.

    atul-port[31] (AT_RANGEINT(0-65535), Optional, default: <none>)
        if > 0, a process on this cluster is listening for ATUL protocol
        queries on this port number.

    cluster-id[11] (AT_SHORT, Optional, default: <none>)
        Identifies the local cluster that is the authoritative source
        for this object.  This attribute is set as part of replica data
        propagation.

    fqdn[2] (AT_DNSNAME, Optional, default: <none>)
        Provides the fully qualified domain name of this server.
        This attribute is not used to contact the cluster.

    http-port[8] (AT_INT, Optional, default: <none>)
        Specifies the http-port to use for non-SSL-secured connections
        to the web server for this cluster.

    https-port[17] (AT_INT, Optional, default: <none>)
        Controls the https-port to use for SSL-secured connections to
        the webserver for this cluster.  This port is only used if the
        value of the use-https-port attribute is true.

    ipaddr[3] (AT_IPADDR, Required, default: <none>)
        Provides the IP address of this server.  This attribute,
        rather than the fqdn is used to connect to the cluster.

    local-servers[12] (AT_NLIST(AT_OBJ), Optional, default: <none>)
        Lists the servers associated with this cluster. This transient
        attribute makes it easier for clients that want to show a tree
        of clusters with their child servers to get all the information
        in a single request.

    name[1] (AT_STRING, Required, default: <none>)
        Names the cluster.

    password[5] (AT_CLEARTEXT, Optional, default: <none>)
        Sets the password that authenticates the identity stored
        in the admin attribute.  Do not use this clear-text value
        except within process memory.  Use the corresponding
        password-secret instead.

    password-secret[7] (AT_SECRET, Optional, default: <none>)
        Sets the identifier of the secret representing the password that
        authenticates the identity stored in the admin attribute.

    poll-lease-hist-interval[15] (AT_RANGETIME, Optional, default: <none>)
        Specifies how often to collect the lease history from the DHCP
        server for this cluster. If set to 0, polling does not occur.

    poll-lease-hist-offset[22] (AT_RANGETIME, Optional, default: <none>)
        Provides a fixed time of day for lease history polling.
        This time is interpreted as a time of day offset, with 0 being
        12 midnight, provided the polling interval is less than 24 hours,
        and the offset value is less than the polling interval. If the offset
        value is greater than the polling interval, or the interval is
        greater than 24 hours, the offset will be ignored.
        The scheduler for polling will ensure that the first polling event
        occurs at the offset time. For example, if you set the interval to
        4 hours and the offset to 2am, the polling would occur at 2am, 6am,
        10am, 2pm, 6pm and 10pm.

    poll-lease-hist-retry[16] (AT_RANGEINT(0-4), Optional, default: <none>)
        Controls how often to retry if lease history polling fails.

    poll-replica-interval[9] (AT_TIME, Optional, default: 4h)
        Set the automatic replication interval; that is, how often
        Network Registrar polls this server for replica data.

    poll-replica-offset[10] (AT_TIME, Optional, default: 4h)
        Sets a fixed time of day for replica polling.
        This time is interpreted as a time of day offset, with 0 being
        12 midnight, provided that:
            the polling interval is less than 24 hours, and
            the offset value is less than the polling interval.
        If the offset value is greater than the polling interval, or
        the interval is greater than 24 hours, the offset is ignored.
        The scheduler for polling ensures that the first polling event
        occurs at the offset time. For example, if you set the interval
        to 4 hours and the offset to 2am, the polling would occur at
        2am, 6am,  10am, 2pm, 6pm and 10pm.

    poll-subnet-util-interval[13] (AT_RANGETIME, Optional, default: <none>)
        Specifies how often to collect subnet utilization data from
        the DHCP server for this cluster. If set to 0, polling does
        not occur.

    poll-subnet-util-offset[23] (AT_RANGETIME, Optional, default: <none>)
        Provides a fixed time of day for subnet utilization polling.
        This time is interpreted as a time of day offset, with 0 being
        12 midnight, provided the polling interval is less than 24 hours,
        and the offset value is less than the polling interval. If the offset
        value is greater than the polling interval, or the interval is
        greater than 24 hours, the offset will be ignored.
        The scheduler for polling will ensure that the first polling event
        occurs at the offset time. For example, if you set the interval to
        4 hours and the offset to 2am, the polling would occur at 2am, 6am,
        10am, 2pm, 6pm and 10pm.

    poll-subnet-util-retry[14] (AT_RANGEINT(0-4), Optional, default: <none>)
        Controls how often to retry if subnet utilization polling fails.

    product-version[26] (AT_PCV, Optional, default: <none>)
        The product version number of the cluster in major, minor, rev form.
        This value is updated when the cluster is resynchronized.

    remote-id[20] (AT_SHORT, Optional, default: <none>)
        Sets the ID on the remote cluster that refers back to the
        local cluster. If there are two cluster objects on two servers
        that share a secret and refer to each other, then the local ID =
        the remote-id, the local remote ID = the remote ID, and the value
        of the local shared secret = the value the remote shared secret.

    replication-initialized[21] (AT_BOOL, Optional, default: false)
        Indicates whether data replication has already been initialized
        on this cluster.

    restore-state[28] (AT_ENUMSHORT(), Optional, default: active)
        Indicates whether the cluster has been deactivated or is in the
        process of being restored from the replica db.

    scp-port[6] (AT_INT, Optional, default: <none>)
        Controls the port number used for SCP communications.

    scp-read-timeout[25] (AT_TIME, Optional, default: 20m)
        The time limit for how long we should wait for data when
        reading an SCP message from this cluster.

    shared-secret[19] (AT_SECRET, Optional, default: <none>)
        Specifies the identifier for the secret shared between the
        server storing this object and the cluster it represents.
        This shared secret is used to generate single-sign-on
        authentication tokens.

    use-https-port[18] (AT_BOOL, Optional, default: false)
        Controls whether the https-port is used to make single sign-on
        connections to the cluster.  If the value is false, or the
        https-port attribute is not set, then the http-port is used.

    use-ssl[24] (AT_ENUMSTR(), Optional, default: optional)
        What security mode should we use when connecting to this cluster.
        If optional, and we have a security library installed, we will
        try to secure the connection.  If required, we will not make
        the connection unless we can secure the connection (this requires
        the security library to be installed).  If none, we will not
        try to secure the connection.

