router (nrcmd)						router (nrcmd)


NAME
    router - Configures a router

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

DESCRIPTION
    The router command lets you configure a router.

    Be aware that while the type attribute is optional, it is
    needed to synchronize router-interface changes to the router.
        
EXAMPLES

STATUS

SEE ALSO
    router-type, router-interface

PROPERTIES
  Attributes:

    address[2] (AT_IPADDR, Required, default: <none>)
        Sets the management interface address for this router.

    description[19] (AT_STRING, Optional, default: <none>)
        Describes this router.

    device-timeout[20] (AT_INT, Optional, default: 60)
        Indicates the timeout in seconds. The maximum timeout RIC
        server's communication handler will wait for data from the router.

    enable[6] (AT_CLEARTEXT, Optional, default: <none>)
        Sets the enable password, in clear-text form. Avoid
        this field in normal use and never send the password
        over insecure links.  Use this field to provide the
        clear-text password to the RIC server which intentionally
        does not have access to the secret storage module.

    enable-secret[7] (AT_SECRET, Optional, default: <none>)
        Identifies the secret containing the clear-text password
        for enabling super-user access to the router.

    interfaces[17] (AT_NLIST(AT_OBJ), Optional, default: <none>)
        Lists objects describing the interfaces associated with
        this router.  This is used when the RIC server is returning
        information about a router and its interfaces, or when the
        CCM server is returning a list of routers and interfaces for
        the UI to display a tree of routers and interfaces.

    login-temp-obj[12] (AT_OBJ, Optional, default: <none>)
        Specifies the actual login template object.  This attribute
        is used so that the CCM server can provide the login template
        to the stateless RIC server.

    login-template[11] (AT_NAMEREF(1454), Optional, default: <none>)
        Names an optional login template that to use
        to further customize the RIC server's login and enable
        interaction sessions.

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

    owner[8] (AT_OID, Optional, default: <none>)
        Controls the owner of this object.  This owner field
        is used to group similarly owned routers and can be used
        to limit administrative access.

    password[4] (AT_CLEARTEXT, Optional, default: <none>)
        Determines the password that authenticates the username.
        Avoid this field in normal use and never send the password
        over insecure links.  Use this field to provide the
        clear-text password to the RIC server which intentionally
        does not have access to the secret storage module.

    password-secret[5] (AT_SECRET, Optional, default: <none>)
        Identifies the secret containing the clear-text password for
        authenticating the username.

    region[9] (AT_OID, Optional, default: <none>)
        Controls the region associated with this object.  This
        region field is used to group similarly located routers
        and can be used to limit administrative access.

    type[10] (AT_NAMEREF(1447), Optional, default: <none>)
        Specifies the type of the router.  This is needed so that
        the RIC server can use the correct implementation of the
        router-specific interface.

    use-ssh[18] (AT_ENUMINT(), Optional, default: 1)
        Specifies whether the RIC server should (or must) use SSH
        when communicating with the router.

    username[3] (AT_STRING, Optional, default: <none>)
        Identifies the username to log in to this router.

    virtual-router[21] (AT_BOOL, Optional, default: false)
        Indicates that the Router object is not managed by the
        RIC server. This feature may be used when there is no network
        connectivity to the router, or when synchronization with the
        network configuration is not desired. A virtual router
        configuration is stored in the CCM database, but no attempt is
        made to push the configuration to the router, or to synchronize
        any configuration changes from the router.

