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-server-30</id>
        <!--vim type [OPENSTACK|VMWARE_VSPHERE|LIBVIRT|AWS|CSP]-->
        <type>OPENSTACK</type>
        <properties>
          <property>
            <name>os_auth_url</name>
            <value>http://<os_ip:port>/v3</value>
          </property>
          <!-- The project name for openstack authentication and authorization -->
          <property>
            <name>os_project_name</name>
            <value>vimProject</value>
          </property>
          <!-- The project domain name is needed for openstack v3 identity api -->
          <property>
            <name>os_project_domain_name</name>
            <value>default</value>
          </property>
        </properties>
        <users>
          <user>
            <id>admin</id>
            <credentials>
              <properties>
                <property>
                  <name>os_password</name>
                  <value>********</value>
                </property>
                <!-- The user domain name is needed for openstack v3 identity api -->
                <property>
                  <name>os_user_domain_name</name>
                  <value>default</value>
                </property>
              </properties>
            </credentials>
          </user>
        </users>
      </vim_connector>
    </vim_connectors>
  </esc_system_config>
  
  

  Note

  In 3.0, multiple VIM connectors are supported but within one ESC instance, all the VIM connectors have to in one VIM type (e.g. OpenStack, VMware). One VIM is chosen as the default VIM which supports all pre 3.0 config requests and datamodels. Deployments can be done on the VIM that is not the default VIM. The deployment to a non default VIM has to have all out-of-band resources (except ephemeral volumes). No other configurations like image, flavor, network, and so on can be done on the VIM that is not the default VIM. The default VIM connector will be auto provisioned and does not need to be configured in the following scenarios: If VIM credentials have been passed during ESC boot up. If upgrading from 2.3.x to 3.0. The change in the datamodel for Openstack create VIM connector would be handled during upgrade by migration. The 'os_tenant_name' and 'os_project_domain_name' properties would be moved to the VIM Connector properties and 'os_ternant_name' will be renamed to 'os_project_name'. For the default VIM Connector, once it is properly authenticated, its properties cannot be updated. VIM user can be deleted, recreated, or its properties can be updated at anytime.

• 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>{auth_url}</value>
          </property>
          <property>
            <name>os_project_name</name>
            <value>vimProject</value>
          </property>
          <!-- The project domain name is only needed for openstack v3 identity api -->
          <property>
            <name>os_project_domain_name</name>
            <value>default</value>
          </property>
          <property>
            <name>os_identity_api_version</name>
            <value>3</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>********</value>
                </property>
                <!-- The user domain name is only needed for openstack v3 identity api -->
                <property>
                  <name>os_user_domain_name</name>
                  <value>default</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:

  $/esc_nc_cli delete-vim-connector <vim connector id
  

• Deleting VIM user using command:

  $/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">
    <id>example_vim</id>
    <type>OPENSTACK</type>
    <properties>
      <property>
        <name>os_auth_url</name>
        <value>{auth_url}</value>
      </property>
      <property>
        <name>os_project_name</name>
        <value>vimProject</value>
      </property>
      <!-- The project domain name is only needed for openstack v3 identity api -->
      <property>
        <name>os_project_domain_name</name>
        <value>default</value>
      </property>
      <property>
        <name>os_identity_api_version</name>
        <value>3</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>my_user</id>
    <credentials>
      <properties>
        <property>
          <name>os_password</name>
          <value>********</value>
        </property>
        <!-- The user domain name is only needed for openstack v3 identity api -->
        <property>
          <name>os_user_domain_name</name>
          <value>default</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>example_vim</id>
    <type>OPENSTACK</type>
    <properties>
      <property>
        <name>os_auth_url</name>
        <value>{auth_url}</value>
      </property>
      <property>
        <name>os_project_name</name>
        <value>vimProject</value>
      </property>
      <!-- The project domain name is only needed for openstack v3 identity api -->
      <property>
        <name>os_project_domain_name</name>
        <value>default</value>
      </property>
      <property>
        <name>os_identity_api_version</name>
        <value>3</value>
      </property>
   </properties>
  </vim_connector>
  

• Update VIM user using REST:

  PUT /ESCManager/v0/vims/{vim_id}/vim_users/{vim_user_id}
  HEADER: content-type, callback
   
  <?xml version="1.0"?>
  <user xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
    <id>my_user</id>
    <credentials>
      <properties>
        <property>
          <name>os_password</name>
          <value>********</value>
        </property>
        <!-- The user domain name is only needed for openstack v3 identity api -->
        <property>
          <name>os_user_domain_name</name>
          <value>default</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-server-30</vim_connector_id>
      <event>
        <type>CREATE_VIM_CONNECTOR</type>
      </event>
    </escEvent>
  </notification>
  

  Important Notes:

  • In ESC 3.0, you can add multiple VIM Connector for Openstack VIM. Each VIM Connector can have only one VIM User.

  • 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 can no longer be deleted or updated, only VIM user can be deleted or 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.

Verifying Existing ESC Configurations

$ sudo escadm dump

resources:
  confd:
    init_aaa_users:
    - name: admin
      passwd: 
    option: start-phase0
  esc_service:
    group:
    - confd
    - mona
    - vimmanager
    - pgsql
    - escmanager
    - portal
    - monitor
    - snmp
    type: group
  escmanager: {}
  mona: {}
  monitor: {}
  pgsql: {}
  portal: {}
  snmp:
    run_forever: true
  vimmanager: {}

Verifying VIM configurations

You can use escadm vim show command to verify the vim settings are correctly populated:

$ sudo escadm vim show

[
    {
        "status": "CONNECTION_SUCCESSFUL",
        "status_message": "Successfully connected to VIM",
        "type": "OPENSTACK",
        "id": "default_openstack_vim",
        "properties": {
            "property": [
                {
                    "name": "os_auth_url",
                    "value": "http://10.85.103.143:35357/v3"
                }
            ]
        }
    }
]

Troubleshooting ESC Services Startup Issues

Problem: Issues encountered while verifying ESC services status at the installation time using sudo escadm status.

Causes: Some services take time to start or have trouble starting.