Note

The ESC portal is enabled by default. You must ensure that the ESC portal is not disabled during installation. For more information on enabling or disabling the ESC portal, see Installing Cisco Elastic Services Controller Using the QCOW Image. When you log in to the ESC portal for the first time you are prompted to change the default password.

To log in to the ESC portal, do the following:

You will be forced to change the default password on first time login. Portal will not let you bypass this step and will keep returning you to this page until you change the default password. After the first time password change, you can change your password using the procedures described in this section. Also, if the user has multiple browsers or tabs or the SAME user is logged on by 2 or more computers and one of the user changes the password then everyone will be logged off and asked to re-enter the new password. The user session has an expiry of 1 hour so if the user is inactive on the portal for an hour then portal will expire the session and the user will have to re-login. If you forgot your password, you can also reset the password.

This section discusses how to change the passwords.

ESC REST API uses http basic access authentication where the ESC client will have to provide a username and password when making ESC REST requests. The user name and password will be encoded with Base64 in transit, but not encrypted or hashed. HTTPS will be used in conjunction with Basic Authentication to provide the encryption.

This section discusses how to enable the REST authentication, change the default password of the REST interface, and how to send authorized REST request from the ESC client.

Configuring using Netconf API

• Passing VIM credential using Netconf :

  
  <esc_system_config xmlns="http://www.cisco.com/esc/esc">
    <vim_connectors>
      <!--represents a vim-->
      <vim_connector>
        <!--unique id for each vim-->
        <id>my-ucs-30</id>
        <!--vim type [OPENSTACK|VMWARE|VAGRANT|...]-->
        <type>OPENSTACK</type>
        <properties>
          <property>
            <name>os_auth_url</name>
            <value>http://<ip address>:5000/v2.0</value>
          </property>
        </properties>
  	  <users>
          <user>
            <id>admin</id>
            <credentials>
              <properties>
                <property>
                  <name>os_password</name>
                  <value>cisco123</value>
                </property>
                <property>
                  <name>os_tenant_name</name>
                  <value>admin</value>
                </property>
              </properties>
            </credentials>
          </user>
        </users>
      </vim_connector>
    </vim_connectors>
  </esc_system_config>
  
  

• Updating VIM Connector using Netconf:

  
  <esc_system_config xmlns="http://www.cisco.com/esc/esc">
    <vim_connectors>
      <vim_connector nc:operation="replace">
        <id>example_vim</id>
        <type>OPENSTACK</type>
        <properties>
          <property>
            <name>os_auth_url</name>
            <value>http://<ip address>:5000/v2.0</value>
          </property>
        </properties>
      </vim_connector>
    </vim_connectors>
  </esc_system_config>
  
  

• Updating VIM user using Netconf:

  <esc_system_config xmlns="http://www.cisco.com/esc/esc">
    <vim_connectors>
      <vim_connector>
        <id>example_vim</id>
          <users>
            <user nc:operation="replace">
              <id>my_user</id>
              <credentials>
               <properties>
                <property>
                  <name>os_password</name>
                  <value>cisco123</value>
                </property>
                <property>
                  <name>os_tenant_name</name>
                  <value>admin</value>
                </property>
              </properties>
             </credentials>
            </user>
          </users>
      </vim_connector>
    </vim_connectors>
  </esc_system_config>

• Deleting VIM connector using Netconf:

  
  <esc_system_config xmlns="http://www.cisco.com/esc/esc">  <vim_connectors>
      <vim_connector nc:operation="delete">
        <id>example_vim</id>
      </vim_connector>
    </vim_connectors>
  </esc_system_config>
  
  

• Deleting VIM Connector using command:

  $/opt/cisco/esc/esc-confd/esc-cli/esc_nc_cli delete-vim-connector <vim connector id

• Deleting VIM user using command:

  $/opt/cisco/esc/esc-confd/esc-cli/esc_nc_cli delete-vim-user <vim connector id> <vim user id>

Configuring using REST API

• Adding VIM using REST:

  POST /ESCManager/v0/vims/
  HEADER: content-type, callback
  
  <?xml version="1.0"?>
  <vim_connector xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
    <!--unique id for each vim-->
    <id>my-ucs-30</id>
    <!--vim type [OPENSTACK|VMWARE|VAGRANT|...]-->
    <type>OPENSTACK</type>
    <properties>
      <property>
        <name>os_auth_url</name>
        <value>http://10.85.103.37:5000/v2.0</value>
      </property>
    </properties>
  </vim_connector>

• Adding VIM user using REST:

  POST /ESCManager/v0/vims/{vim_id}/vim_users
  HEADER: content-type, callback
  
  <?xml version="1.0"?>
  <user xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
    <id>admin</id>
    <credentials>
      <properties>
        <property>
          <name>os_password</name>
          <value>cisco1234</value>
        </property>
        <property>
          <name>os_tenant_name</name>
          <value>admin</value>
        </property>
      </properties>
    </credentials>
  </user>

• Update VIM using REST:

  PUT /ESCManager/v0/vims/{vim_id}
  HEADER: content-type, callback
  
  <?xml version="1.0"?>
  <vim_connector xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
    <!--unique id for each vim-->
    <id>my-ucs-30</id>
    <!--vim type [OPENSTACK|VMWARE|VAGRANT|...]-->
    <type>OPENSTACK</type>
    <properties>
      <property>
        <name>os_auth_url</name>
        <value>http://10.85.103.37:5000/v2.0</value>
      </property>
    </properties>
  </vim_connector>

• Update VIM user using REST:

  PUT /ESCManager/v0/vims/{vim_id}/vim_users/{user_id}
  HEADER: content-type, callback
  
  <?xml version="1.0"?>
  <user xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
    <id>admin</id>
    <credentials>
      <properties>
        <property>
          <name>os_password</name>
          <value>cisco1234</value>
        </property>
        <property>
          <name>os_tenant_name</name>
          <value>admin</value>
        </property>
      </properties>
    </credentials>
  </user>

• Delete VIM using REST:

  DELETE /ESCManager/v0/vims/{vim_id}

• Delete VIM user using REST:

  DELETE /ESCManager/v0/vims/{vim_id}/vim_users/{user_id}

• Notification example after each VIM or VIM user configuration is done :

  
  <?xml version="1.0" encoding="UTF-8"?>
  <notification xmlns="urn:ietf:params:xml:ns:netconf:notification:1.0">
    <eventTime>2016-10-06T16:24:05.856+00:00</eventTime>
    <escEvent xmlns="http://www.cisco.com/esc/esc">
      <status>SUCCESS</status>
      <status_code>200</status_code>
      <status_message>Created vim connector successfully</status_message>
      <vim_connector_id>my-ucs-30</vim_connector_id>
      <event>
        <type>CREATE_VIM_CONNECTOR</type>
      </event>
    </escEvent>
  </notification>
  

  Important Notes:

  • ESC 2.3 only support one VIM and one VIM user combination per ESC instance. If the VIM and a user is already configured, request to create more will be rejected.

  • VIM username and password can be updated at anytime. VIM endpoint will not be able to update after a resource is created through ESC.

  • After VIM is connected and VIM user is authenticated, VIM and VIM user can no longer be deleted, only VIM username and password can be updated.

  • The name of a VIM property or VIM user credentials property is not case sensitive, e.g. OS_AUTH_URL and os_auth_url is the same to ESC.