OC System Terminal

Packages:

  • openconfig-system.yang
  • openconfig-system-terminal.yang

OC Hostname

OC Hostname

Netconf :

REQUEST
<rpc>
  <edit-config>
    <target>
      <running/>
    </target>
    <config>
      <system xmlns="http://openconfig.net/yang/system">
        <config>
          <hostname xmlns:nc="urn:ietf:params:xml:ns:netconf:base:1.0" nc:operation="merge">TEST</hostname>
        </config>
      </system>
    </config>
  </edit-config>
</rpc> 

RESPONSE
<rpc-reply>
    <ok/>
</rpc-reply> 

Note: This example was added in Release 10.4(1)F.


CLI Command

hostname TEST


Guidelines and Limitations

Following are the guidelines and limitations for the hostname.

  • Hostname read and write through Openconfig is supported.
  • Operations get, get-config and edit-config are supported.
  • Nexus Switches always have a default hostname (switch), edit-config with create will result in appropriate failure.
  • Maximum length of 63 characters and 1 terminating null character is supported in hostname.
  • You cannot start hostname with keywords resource or combined-hostname.
  • Configuring SSH Feature

    Configuring SSH Feature
    
    Request:
    <rpc xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" message-id="101">
      <edit-config>
        <target>
          <running/>
        </target>
        <config>
          <system xmlns="http://openconfig.net/yang/system">
            <ssh-server>
              <config>
                <enable>true</enable>
              </config>
            </ssh-server>
          </system>
        </config>
      </edit-config>
    </rpc>
    
    Response:
    
    <rpc-reply xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" message-id="urn:uuid:0ee53f52-f02a-4d48-8a11-cab4897099b2">
        <ok/>
    </rpc-reply>
    

    Container: ssh-server Type: Config Data


    CLI Commands

    feature ssh

    Disabling SSH Feature

    Disabling SSH Feature
    
    Request:
    
    <rpc xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" message-id="101">
      <edit-config>
        <target>
          <running/>
        </target>
        <config>
          <system xmlns="http://openconfig.net/yang/system">
            <ssh-server>
              <config>
                <enable>false</enable>
              </config>
            </ssh-server>
          </system>
        </config>
      </edit-config>
    </rpc>
    Response:
    
    <rpc-reply xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" message-id="urn:uuid:0ee53f52-f02a-4d48-8a11-cab4897099b2">
        <ok/>
    </rpc-reply>
    


    CLI Commands

    no feature ssh

    Configuring the Inactive Session Timeout

    Configuring the Inactive Session Timeout
    
    Request:
    
    <nc:rpc xmlns:nc="urn:ietf:params:xml:ns:netconf:base:1.0" message-id="urn:uuid:57459425-cc1a-4434-b1aa-f449d43d9372">
      <nc:edit-config>
        <nc:target>
          <nc:running/>
        </nc:target>
        <nc:config>
          <system xmlns="http://openconfig.net/yang/system">
            <ssh-server>
              <config>
                <enable/>
                <timeout>10</timeout>
              </config>
            </ssh-server>
          </system>
        </nc:config>
      </nc:edit-config>
    </nc:rpc>
    
    Response:
    
    <rpc-reply xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" message-id="urn:uuid:0ee53f52-f02a-4d48-8a11-cab4897099b2">
        <ok/>
    </rpc-reply>
    


    CLI Commands

    line vty
    exec-timeout 10

    Removing the Inactive Session Timeout

    Removing the Inactive Session Timeout
    
    Request:
    <rpc xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" message-id="101">
      <edit-config>
        <target>
          <running/>
        </target>
        <config>
          <system xmlns="http://openconfig.net/yang/system">
            <ssh-server>
              <config>
                <timeout xmlns:nc="urn:ietf:params:xml:ns:netconf:base:1.0" nc:operation="delete">10</timeout>
              </config>
            </ssh-server>
          </system>
        </config>
      </edit-config>
    </rpc>
    Response:
    
    <rpc-reply xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" message-id="urn:uuid:0ee53f52-f02a-4d48-8a11-cab4897099b2">
        <ok/>
    </rpc-reply>
    


    CLI Commands

    line vty
    no exec-timeout 10

    Configuring the maximum number of Virtual Sessions for the Device

    Configuring the maximum number of Virtual Sessions for the Device
    
    Request:
    
    <rpc xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" message-id="101">
      <edit-config>
        <target>
          <running/>
        </target>
        <config>
          <system xmlns="http://openconfig.net/yang/system">
            <ssh-server>
              <config>
                <session-limit>10</session-limit>
              </config>
            </ssh-server>
          </system>
        </config>
      </edit-config>
    </rpc>
    
    Response:
    
    <rpc-reply xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" message-id="urn:uuid:0ee53f52-f02a-4d48-8a11-cab4897099b2">
        <ok/>
    </rpc-reply>
    


    CLI Commands

    line vty
    session-limit 10

    Removing the Maximum Number of Virtual Sessions for the Device

    Removing the Maximum Number of Virtual Sessions for the Device
    
    Request:
    <rpc xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" message-id="101">
      <edit-config>
        <target>
          <running/>
        </target>
        <config>
          <system xmlns="http://openconfig.net/yang/system">
            <ssh-server>
              <config>
                <session-limit xmlns:nc="urn:ietf:params:xml:ns:netconf:base:1.0" nc:operation="delete">10</session-limit>
              </config>
            </ssh-server>
          </system>
        </config>
      </edit-config>
    </rpc>
    
    Response:
    
    <rpc-reply xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" message-id="urn:uuid:0ee53f52-f02a-4d48-8a11-cab4897099b2">
        <ok/>
    </rpc-reply>
    


    CLI Commands

    line vty
    no session-limit 10

    Querying SSH Container

    Querying SSH container
    
    Request:
    <nc:rpc xmlns:nc="urn:ietf:params:xml:ns:netconf:base:1.0" message-id="urn:uuid:1a22dc0b-938e-44a7-b183-8b7ca790e5c4">
      <nc:get-config>
        <nc:source>
          <nc:running/>
        </nc:source>
        <nc:filter>
          <system xmlns="http://openconfig.net/yang/system">
            <ssh-server/>
          </system>
        </nc:filter>
      </nc:get-config>
    </nc:rpc>
    
    
    Response:
    <rpc-reply xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" message-id="urn:uuid:1a22dc0b-938e-44a7-b183-8b7ca790e5c4">
        <data>
            <system xmlns="http://openconfig.net/yang/system">
                <ssh-server>
                    <config>
                        <enable>true</enable>
                        <session-limit>32</session-limit>
                        <timeout>30</timeout>
                    </config>
                </ssh-server>
            </system>
        </data>
    </rpc-reply>
    

    Configuring and Querying Telnet

    Querying Server Group List (GET config)

    Querying Server Group List (GET config)
    
    <nc:rpc xmlns:nc="urn:ietf:params:xml:ns:netconf:base:1.0" message-id="urn:uuid:b9ab57f3-c775-446f-827a-c5009cc92d6d">
      <nc:get-config>
        <nc:source>
          <nc:running/>
        </nc:source>
        <filter>
          <system xmlns="http://openconfig.net/yang/system">
            <telnet-server/>
          </system>
        </filter>
      </nc:get-config>
    </nc:rpc>
    
    
    Received:
    <rpc-reply xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" message-id="urn:uuid:b9ab57f3-c775-446f-827a-c5009cc92d6d">
        <data>
            <system xmlns="http://openconfig.net/yang/system">
                <telnet-server>
                    <config>
                        <enable>false</enable>
                    </config>
                </telnet-server>
            </system>
        </data>
    </rpc-reply>
    

    Note: This example was added in Release 9.3(5).


    CLI Commands

    The CLI commands are equivalent to the payload examples displayed in the pane on the right.

    show telnet server

    Enabling Telnet

    Enabling Telnet
    
    <nc:rpc xmlns:nc="urn:ietf:params:xml:ns:netconf:base:1.0" message-id="urn:uuid:fca9b800-e399-4c68-9337-0395d8e49b9c">
      <nc:edit-config>
        <nc:target>
          <nc:running/>
        </nc:target>
        <config>
          <system xmlns="http://openconfig.net/yang/system">
            <telnet-server>
              <config>
                <enable>true</enable>
              </config>
            </telnet-server>
          </system>
        </config>
      </nc:edit-config>
    </nc:rpc>
    
    
    Received:
    <rpc-reply xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" message-id="urn:uuid:fca9b800-e399-4c68-9337-0395d8e49b9c">
        <ok/>
    </rpc-reply>
    </rpc>
    

    Note: This example was added in Release 9.3(5).


    CLI Commands

    The CLI commands are equivalent to the payload examples displayed in the pane on the right.

    feature telnet

    Setting Enable to False

    Setting Enable to False
    
    <nc:rpc xmlns:nc="urn:ietf:params:xml:ns:netconf:base:1.0" message-id="urn:uuid:026359ee-856b-4b16-bb23-fdd2496a300b">
      <nc:edit-config>
        <nc:target>
          <nc:running/>
        </nc:target>
        <config>
          <system xmlns="http://openconfig.net/yang/system">
            <telnet-server>
              <config>
                <enable>false</enable>
              </config>
            </telnet-server>
          </system>
        </config>
      </nc:edit-config>
    </nc:rpc>
    
    
    Sending:
    
    <nc:rpc xmlns:nc="urn:ietf:params:xml:ns:netconf:base:1.0" message-id="urn:uuid:fed4bdbf-5a70-4a74-bfa0-8f50e350b83a">
      <nc:close-session/>
    </nc:rpc>
    
    Received:
    <rpc-reply xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" message-id="urn:uuid:026359ee-856b-4b16-bb23-fdd2496a300b">
        <ok/>
    </rpc-reply>
    

    Note: This example was added in Release 9.3(5).


    CLI Commands

    The CLI commands are equivalent to the payload examples displayed in the pane on the right.

    no feature telnet

    Configuring and Querying SSH

    Querying the SSH-Server Container

    Querying the SSH-Server Container
    
    <nc:rpc xmlns:nc="urn:ietf:params:xml:ns:netconf:base:1.0" message-id="urn:uuid:e29a0c95-f471-453f-8d80-a044a8e606f8">
      <nc:get-config>
        <nc:source>
          <nc:running/>
        </nc:source>
        <filter>
          <system xmlns="http://openconfig.net/yang/system">
            <ssh-server/>
          </system>
        </filter>
      </nc:get-config>
    </nc:rpc>
    
    Received:
    <rpc-reply xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" message-id="urn:uuid:e29a0c95-f471-453f-8d80-a044a8e606f8">
        <data>
            <system xmlns="http://openconfig.net/yang/system">
                <ssh-server>
                    <config>
                        <enable>true</enable>
                        <session-limit>32</session-limit>
                        <timeout>30</timeout>
                    </config>
                </ssh-server>
            </system>
        </data>
    </rpc-reply>
    

    Note: This example was added in Release 9.3(5).


    CLI Commands

    The CLI commands are equivalent to the payload examples displayed in the pane on the right.

    show ssh server

    Note: There are no CLIs for querying the session-limit or the timeout value.

    Setting Enable to True

    Setting Enable to True
    
    <nc:rpc xmlns:nc="urn:ietf:params:xml:ns:netconf:base:1.0" message-id="urn:uuid:f35d7800-0db6-48b3-9245-022e8bc6dc17">
      <nc:edit-config>
        <nc:target>
          <nc:running/>
        </nc:target>
        <config>
          <system xmlns="http://openconfig.net/yang/system">
            <ssh-server>
              <config>
                <enable>true</enable>
              </config>
            </ssh-server>
          </system>
        </config>
      </nc:edit-config>
    </nc:rpc>
    
    Received:
    <rpc-reply xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" message-id="urn:uuid:f35d7800-0db6-48b3-9245-022e8bc6dc17">
        <ok/>
    </rpc-reply>
    

    Note: This example was added in Release 9.3(5).


    CLI Commands

    The CLI commands are equivalent to the payload examples displayed in the pane on the right.

    feature ssh

    Setting Enable to False

    Setting Enable to False
    
    <nc:rpc xmlns:nc="urn:ietf:params:xml:ns:netconf:base:1.0" message-id="urn:uuid:fe866637-d4d8-4431-9438-725b56ebe581">
      <nc:edit-config>
        <nc:target>
          <nc:running/>
        </nc:target>
        <config>
          <system xmlns="http://openconfig.net/yang/system">
            <ssh-server>
              <config>
                <enable>false</enable>
              </config>
            </ssh-server>
          </system>
        </config>
      </nc:edit-config>
    </nc:rpc>
    
    Received:
    <rpc-reply xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" message-id="urn:uuid:fe866637-d4d8-4431-9438-725b56ebe581">
        <ok/>
    </rpc-reply>
    

    Note: This example was added in Release 9.3(5).


    CLI Commands

    The CLI commands are equivalent to the payload examples displayed in the pane on the right.

    no feature ssh

    Setting the Session Limit

    Setting the Session Limit
    
    <nc:rpc xmlns:nc="urn:ietf:params:xml:ns:netconf:base:1.0" message-id="urn:uuid:08b07d6a-ba88-49d4-9c5f-0e80a47b3c07">
      <nc:edit-config>
        <nc:target>
          <nc:running/>
        </nc:target>
        <config>
          <system xmlns="http://openconfig.net/yang/system">
            <ssh-server>
              <config>
                <session-limit>64</session-limit>
              </config>
            </ssh-server>
          </system>
        </config>
      </nc:edit-config>
    </nc:rpc>
    
    Received:
    <rpc-reply xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" message-id="urn:uuid:08b07d6a-ba88-49d4-9c5f-0e80a47b3c07">
        <ok/>
    </rpc-reply>
    

    Note: This example was added in Release 9.3(5).


    CLI Commands

    The CLI commands are equivalent to the payload examples displayed in the pane on the right.

    line vty
    session-limit <number>

    Setting the Timeout Value

    Setting the Timeout Value
    
    <nc:rpc xmlns:nc="urn:ietf:params:xml:ns:netconf:base:1.0" message-id="urn:uuid:bb1cf456-dde0-451e-ac8c-303c63750027">
      <nc:edit-config>
        <nc:target>
          <nc:running/>
        </nc:target>
        <config>
          <system xmlns="http://openconfig.net/yang/system">
            <ssh-server>
              <config>
                <timeout>40</timeout>
              </config>
            </ssh-server>
          </system>
        </config>
      </nc:edit-config>
    </nc:rpc>
    
    Received:
    <rpc-reply xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" message-id="urn:uuid:bb1cf456-dde0-451e-ac8c-303c63750027">
        <ok/>
    </rpc-reply>
    

    Note: This example was added in Release 9.3(5).


    CLI Commands

    The CLI commands are equivalent to the payload examples displayed in the pane on the right.

    ssh idle-timeout 40