Cisco Cisco Elastic Services Controller 1.0 User Manuals

Table of Contents

• 1 Introduction

  5
  • 1.1 Using NETCONF

    5
    • 1.1.1 Get configuration

      5
    • 1.1.2 Get non-configurable data

      5
    • 1.1.3 Subscribe ESC notifications

      5
    • 1.1.4 Make RPC calls

      5
    • 1.1.5 Push in configurations

      5
  • 1.2 ConfD CLI

    5
  • 1.3 Change ConfD Admin Password

    5
  • 1.4 NETCONF Protocol Operations

    6
  • 1.5 NETCONF Capabilities

    7
• 2 Configuration Data

  9
  • 2.1 Reading Configuration Data

    9
    • 2.1.1 Fetching all config data

      9
      • 2.1.1.1 Netconf Request

        9
      • 2.1.1.2 Netconf Response

        9
    • 2.1.2 Example: Fetching deployed services by network name

      12
      • 2.1.2.1 Netconf Request

        12
      • 2.1.2.2 Netconf Response

        12
  • 2.2 Writing Configuration Data (CRUD operations)

    13
    • 2.2.1 Stage 1: Acceptance or Rejection of a Configuration Request

      13
    • 2.2.2 Stage 2: Activation of a new Configuration

      14
      • 2.2.2.1 Event Notifications

        14
      • 2.2.2.2 Operational Data

        14
      • 2.2.2.3 Activation Failures

        14
    • 2.2.3 Configuration Workflows

      14
    • 2.2.4 Combining Workflows

      14
• 3 Operational Data

  16
  • 3.1 Reading Operational Data

    16
    • 3.1.1 Fetching all operational data

      16
      • 3.1.1.1 Netconf Request

        16
      • 3.1.1.2 Netconf Response

        16
• 4 Custom RPC Methods

  18
  • 4.1 serviceAction method

    18
  • 4.2 vmAction method

    18
• 5 ESC Workflows using Netconf

  18
  • 5.1 Configuration Workflows

    18
    • 5.1.1 Create Tenant

      18
      • 5.1.1.1 Netconf Request

        18
      • 5.1.1.2 Netconf Response

        18
      • 5.1.1.3 Configuration Activation

        19
        • On Success:

          19
          • Event notification

            19
          • Operational data

            19
            • Netconf Request

              19
            • Netconf Response

              19
        • On Failure:

          20
          • Event notification

            20
          • Operational data

            20
          • Handling Activation Failures

            20
    • 5.1.2 Delete Tenant

      21
      • 5.1.2.1 Netconf Request

        21
      • 5.1.2.2 Netconf Response

        21
      • 5.1.2.3 Configuration Activation

        21
        • On Success:

          21
          • Event notification

            21
          • Operational data

            22
        • On Failure:

          22
          • Event notification

            22
          • Operational data

            22
          • Handling Activation Failures

            22
    • 5.1.3 Create Network

      23
      • 5.1.3.1 Netconf Request

        23
      • 5.1.3.2 Netconf Response

        23
      • 5.1.3.3 Configuration Activation

        23
        • On Success:

          23
          • Event notification

            23
        • On Failure:

          24
          • Event notification

            24
          • Handling Activation Failures

            24
    • 5.1.4 Delete Network

      25
      • 5.1.4.1 Netconf Request

        25
      • 5.1.4.2 Netconf Response

        25
      • 5.1.4.3 Configuration Activation

        25
        • On Success:

          25
          • Event notification

            25
        • On Failure:

          26
          • Event notification

            26
          • Handling Activation Failures

            26
    • 5.1.5 Create Subnet

      27
      • 5.1.5.1 Netconf Request

        27
      • 5.1.5.2 Netconf Response

        27
      • 5.1.5.3 Configuration Activation

        27
        • On Success:

          27
          • Event notification

            27
        • On Failure:

          28
          • Event notification

            28
          • Handling Activation Failures

            28
    • 5.1.6 Delete Subnet

      29
      • 5.1.6.1 Netconf Request

        29
      • 5.1.6.2 Netconf Response

        29
      • 5.1.6.3 Configuration Activation

        29
        • On Success:

          29
          • Event notification

            29
        • On Failure:

          30
          • Event notification

            30
          • Handling Activation Failures

            30
    • 5.1.7 Register Service with the Service Catalog

      30
      • 5.1.7.1 Netconf Request

        30
      • 5.1.7.2 Netconf Response

        31
      • 5.1.7.3 Configuration Activation

        31
        • On Success:

          31
          • Event notification

            31
          • Operational data

            31
            • Not applicable. There is no operational data for service registration.

              31
        • On Failure:

          31
          • Event notification

            31
          • Operational data

            32
            • Not applicable. There is no operational data for service registration.

              32
          • Handling Activation Failures

            32
    • 5.1.8 Unregister Service from the Service Catalog

      33
      • 5.1.8.1 Netconf Request

        33
      • 5.1.8.2 Netconf Response

        33
      • 5.1.8.3 Configuration Activation

        33
        • On Success:

          33
          • Event notification

            33
          • Operational data

            34
            • Not applicable. There is no operational data for service registration.

              34
        • On Failure:

          34
          • Event notification

            34
          • Operational data

            34
            • Not applicable. There is no operational data for service registration.

              34
          • Handling Activation Failures

            34
    • 5.1.9 Deploy Service

      35
      • 5.1.9.1 Netconf Request

        35
      • 5.1.9.2 Netconf Response

        37
      • 5.1.9.3 Configuration Activation

        37
        • Workflow Aggregation:

          37
        • On Success:

          37
          • Event notification

            37
          • Operational data

            39
            • Netconf Request

              39
            • Netconf Response

              39
        • On Failure:

          40
          • Event notification

            40
          • Operational data

            41
          • Handling Activation Failures

            41
    • 5.1.10 Un-deploy Service

      42
      • 5.1.10.1 Netconf Request

        42
      • 5.1.10.2 Netconf Response

        42
      • 5.1.10.3 Configuration Activation

        42
        • Workflow Aggregation:

          42
        • On Success:

          43
          • Event notification

            43
          • Operational data

            44
        • On Failure:

          44
          • Event notification

            44
          • Operational data

            44
          • Handling Activation Failures

            44
    • 5.1.11 Update Service

      44
      • 5.1.11.1 Netconf Request

        45
      • 5.1.11.2 Netconf Response

        47
      • 5.1.11.3 Configuration Activation

        47
        • On Success:

          47
          • Event notification

            47
          • Operational data

            48
            • Netconf Request

              48
            • Netconf Response

              48
        • On Failure:

          50
          • Event notification

            50
          • Operational data

            50
          • Handling Activation Failures

            50
  • 5.2 Operational Workflows

    50
    • 5.2.1 Service Operations

      50
      • 5.2.1.1 Stop Service

        50
        • 5.2.1.1.1 Netconf Request

          50
        • 5.2.1.1.2 Netconf Response

          51
        • 5.2.1.1.3 Event Notifications

          51
      • 5.2.1.2 Start Service

        52
        • 5.2.1.2.1 Netconf Request

          52
        • 5.2.1.2.2 Netconf Response

          52
        • 5.2.1.2.3 Event Notifications

          52
      • 5.2.1.3 Reboot Service

        54
        • 5.2.1.3.1 Netconf Request

          54
        • 5.2.1.3.2 Netconf Response

          54
        • 5.2.1.3.3 Event Notifications

          54
      • 5.2.1.4 Disable Service Monitor

        56
        • 5.2.1.4.1 Netconf Request

          56
        • 5.2.1.4.2 Netconf Response

          56
        • 5.2.1.4.3 Event Notifications

          57
      • 5.2.1.5 Enable Service Monitor

        58
        • 5.2.1.5.1 Netconf Response

          58
        • 5.2.1.5.2 Event Notifications

          58
    • 5.2.2 VM operations

      59
      • 5.2.2.1 Stop VM

        59
        • 5.2.2.1.1 Netconf Request

          59
        • The “force” option in the request decides if ESC considers the min_vm requirement for the service. Since stopping a VM would affect the service availability, after the VM is stopped the min_vm requirement specified in the datamodel may not be satisfitied. If the “force” option is true, ESC will ignore the requirement for min_vm.

          60
        • 5.2.2.1.2 Netconf Response

          60
        • 5.2.2.1.3 Event Notifications

          60
      • 5.2.2.2 Start VM

        61
        • 5.2.2.2.1 Netconf Request

          61
        • 5.2.2.2.2 Netconf Response

          61
        • 5.2.2.2.3 Event Notifications

          61
      • 5.2.2.3 Reboot VM

        63
        • 5.2.2.3.1 Netconf Request

          63
        • The “force” option in the request decides if ESC considers the min_vm requirement for the service. Since stopping a VM would affect the service availability, after the VM is rebooted the min_vm requirement specified in the datamodel may not be satisfitied. If the “force” option is true, ESC will ignore the requirement for min_vm.

          63
        • 5.2.2.3.2 Netconf Response

          63
        • 5.2.2.3.3 Event Notifications

          63
      • 5.2.2.4 Disable VM Monitor

        64
        • 5.2.2.4.1 Netconf Request

          64
        • 5.2.2.4.2 Netconf Response

          65
        • 5.2.2.4.3 Event Notifications

          65
      • 5.2.2.5 Enable VM Monitor

        66
        • 5.2.2.5.1 Netconf Request

          66
        • 5.2.2.5.2 Netconf Response

          66
        • 5.2.2.5.3 Event Notifications

          66
• 6 ESC Triggered Workflows

  67
  • Recovery Initialize

    68
  • Attempts for recovery

    68
  • Recovery complete

    68
  • Success Event notifications

    68
    • On Failure:

      70
      • Event notification

        70
      • Handling Recovery Failures

        70
  • 6.2 Scale Out/Scale in Work Flows

    70
    • 6.2.1 Scale Out Work Flow

      70
      • 6.2.1.1 Event Notifications

        70
    • 6.2.2 Scale In Work Flow

      72
      • 6.2.2.1 Event Notifications

        72