Cisco UCS Central CLI Configuration Guide, Release 1.0
Configuring Call Home
Downloads: This chapterpdf (PDF - 400.0KB) The complete bookPDF (PDF - 2.17MB) | The complete bookePub (ePub - 408.0KB) | Feedback

Configuring Call Home

Configuring Call Home

This chapter includes the following sections:

Call Home Policies

Cisco UCS Central supports global call home policies for notifying all email recipients defined in call home profiles to specific Cisco UCS Manager events. (There is no call home support for Cisco UCS Central in this release.) Profiles define lists of email recipients that receive alert notifications (to a maximum defined message size in full text, short text, or XML format) and alert criteria for triggering notifications.

Alert notifications are sent with predefined content based on alert levels (including major, minor, normal, notification and warning) and selected alert groups identifying events that trigger notification (such as diagnostic, environmental, inventory, license and other predefined events). Individual email recipients may be individually added to existing profiles. Registered Cisco UCS domains choosing to define security policies globally within that client's policy resolution control will defer all call home policies to its registration with Cisco UCS Central.

Configuring a Call Home Policy

A call home policy is created from a domain group under the domain group root. Call home policies under the Domain Groups root that were already created by the system are ready to configure.

Procedure
      Command or Action Purpose
    Step 1 UCSC# connect policy-mgr  

    Enters policy manager mode.

     
    Step 2 UCSC(policy-mgr)# scope domain-group domain-group  

    Enters domain group root mode and (optionally) enters a domain group under the domain group root. To enter the domain group root mode, type / as the domain-group.

     
    Step 3 UCSC(policy-mgr) /domain-group # create callhome  

    If scoping into a domain group previously, creates the Call Home policy for that domain group.

     
    Step 4 UCSC(policy-mgr) /domain-group/callhome* # set contract-id contract-id  

    Sets the contract ID (numeric and/or text; 0-510 characters).

     
    Step 5 UCSC(policy-mgr) /domain-group/callhome* # set customer-id customer-id  

    Sets the customer ID (numeric and/or text; 0-510 characters).

     
    Step 6 UCSC(policy-mgr) /domain-group/callhome* # set hostname smtp-server-address  

    Sets the SMTP server address.

     
    Step 7 UCSC(policy-mgr) /domain-group/callhome* # set phone-contact phone-contact  

    Sets the phone contact number (e.g., +1-011-408-555-1212).

     
    Step 8 UCSC(policy-mgr) /domain-group/callhome* # set port port  

    Sets the port number (1-65535).

     
    Step 9 UCSC(policy-mgr) /domain-group/callhome* # set site-id site-id  

    Sets the site ID (numeric and/or text; 0-510 characters).

     
    Step 10 UCSC(policy-mgr) /domain-group/callhome* # set street-address street-address  

    Sets the street address (0-255 characters).

     
    Step 11 UCSC(policy-mgr) /domain-group/callhome* # set switch-priority switch-priority  

    Sets the switch priority. Parameters available:

    • alerts
    • critical
    • debugging
    • emergencies
    • errors
    • information
    • notifications
    • warnings
     
    Step 12 UCSC(policy-mgr) /domain-group/callhome* # set throttling on | off  

    Sets throttling to on or off.

     
    Step 13 UCSC(policy-mgr) /domain-group/callhome* # commit-buffer  

    Commits the transaction to the system configuration.

     

    The following example shows how to scope into the domain group domaingroup01, create the Call Home policy, configure the Call Home policy, and commit the transaction:

    UCSC # connect policy-mgr
    UCSC(policy-mgr)# scope domain-group domaingroup01
    UCSC(policy-mgr) /domain-group # create callhome
    UCSC(policy-mgr) /domain-group/callhome* # set contract-id contract0995
    UCSC(policy-mgr) /domain-group/callhome* # set customer-id customer112
    UCSC(policy-mgr) /domain-group/callhome* # set hostname 0.0.0.0
    UCSC(policy-mgr) /domain-group/callhome* # set phone-contact +1-011-408-555-1212
    UCSC(policy-mgr) /domain-group/callhome* # set port 65535
    UCSC(policy-mgr) /domain-group/callhome* # set site-id site15
    UCSC(policy-mgr) /domain-group/callhome* # set street-address "75 Main St, Any Town, CA 90000"
    UCSC(policy-mgr) /domain-group/callhome* # set switch-priority notifications
    UCSC(policy-mgr) /domain-group/callhome* # set throttling on
    UCSC(policy-mgr) /domain-group/callhome* # commit-buffer
    UCSC(policy-mgr) /domain-group/callhome # 
    
    What to Do Next

    • Configuring a Profile for a Call Home Policy
    • Adding Email Recipients to a Call Home Policy
    • Configuring a Policy for a Call Home Policy
    • Configuring System Inventory for a Call Home Policy

    Configuring Email for a Call Home Policy

    Before You Begin
    • Create a Call Home Policy.
    • Before adding email addresses to a profile for a call home policy, this profile must first be created.
    Procedure
        Command or Action Purpose
      Step 1 UCSC# connect policy-mgr  

      Enters policy manager mode.

       
      Step 2 UCSC(policy-mgr)# scope domain-group domain-group  

      Enters domain group root mode and (optionally) enters a domain group under the domain group root. To enter the domain group root mode, type / as the domain-group.

       
      Step 3 UCSC(policy-mgr) /domain-group # scope callhome  

      Scopes the default Call Home policy's configuration mode.

       
      Step 4 UCSC(policy-mgr) /domain-group/callhome # set email customer-contact-email  

      Sets the customer's contact email (using standard email address format)

       
      Step 5 UCSC(policy-mgr) /domain-group/callhome* # set from-email from-email  

      Sets the originating or "from" email (using standard email address format)

       
      Step 6 UCSC(policy-mgr) /domain-group/callhome* # set email reply-to-email  

      Sets the email to which customer should reply or "reply-to" email (using standard email address format)

       
      Step 7 UCSC(policy-mgr) /domain-group/callhome* # commit-buffer  

      Commits the transaction to the system configuration.

       

      The following example shows how to scope into the domain group domaingroup01, scope the Call Home policy, set the customer's contact email, from email, and reply to email, and commit the transaction:

      UCSC # connect policy-mgr
      UCSC(policy-mgr)# scope domain-group domaingroup01
      UCSC(policy-mgr) /domain-group # scope callhome
      UCSC(policy-mgr) /domain-group/callhome # set email customer@email.com
      UCSC(policy-mgr) /domain-group/callhome # set from-email from@email.com
      UCSC(policy-mgr) /domain-group/callhome # set reply-to-email reply-to@email.com
      UCSC(policy-mgr) /domain-group/callhome* # commit-buffer
      UCSC(policy-mgr) /domain-group # 
      

      Deleting a Call Home Policy

      A call home policy is deleted from a domain group under the Domain Group root. Call home policies under the Domain Group root cannot be deleted.

      Deleting a call home policy will remove all profiles, policies and system inventory settings within that policy.

      Procedure
          Command or Action Purpose
        Step 1 UCSC# connect policy-mgr  

        Enters policy manager mode.

         
        Step 2 UCSC(policy-mgr)# scope domain-group domain-group  

        Enters a domain group under the domain group root.

        Note   

        Do not enter the domain group root itself. System default Call Home policies cannot be deleted under the domain group root.

         
        Step 3 UCSC(policy-mgr) /domain-group # delete callhome  

        Deletes the Call Home policy for that domain group.

         
        Step 4 UCSC(policy-mgr) /domain-group/callhome* # commit-buffer  

        Commits the transaction to the system configuration.

         

        The following example shows how to scope into the domain group domaingroup01, delete the Call Home policy, and commit the transaction:

        UCSC # connect policy-mgr
        UCSC(policy-mgr)# scope domain-group domaingroup01
        UCSC(policy-mgr) /domain-group # delete callhome
        UCSC(policy-mgr) /domain-group* # commit-buffer
        UCSC(policy-mgr) /domain-group # 
        

        Configuring a Profile for a Call Home Policy

        Before You Begin
        • Create a Call Home Policy.
        • Before configuring a profile for a call home policy in a domain group under the Domain Group root, this profile and policy must first be created.
        Procedure
            Command or Action Purpose
          Step 1 UCSC# connect policy-mgr  

          Enters policy manager mode.

           
          Step 2 UCSC(policy-mgr)# scope domain-group domain-group  

          Enters domain group root mode and (optionally) enters a domain group under the domain group root. To enter the domain group root mode, type / as the domain-group.

           
          Step 3 UCSC(policy-mgr) /domain-group # scope callhome  

          Scopes the default Call Home policy's configuration mode.

           
          Step 4 UCSC(policy-mgr) /domain-group/callhome # create | scope profile profile-name  

          Creates a Call Home policy profile name and enters profile mode, or scopes an existing Call Home policy's profile mode.

           
          Step 5 UCSC(policy-mgr) /domain-group/callhome/profile* # set alertgroups alert-group  

          Sets the profile alert group:

          • ciscotac
          • diagnostic
          • environmental
          • inventory
          • license
          • lifecycle
          • linecard
          • supervisor
          • syslogport
          • system
          • test
           
          Step 6 UCSC(policy-mgr) /domain-group/callhome/profile* # add alertgroups alert-group   (Optional)

          Adds an additional profile alert group:

          • ciscotac
          • diagnostic
          • environmental
          • inventory
          • license
          • lifecycle
          • linecard
          • supervisor
          • syslogport
          • system
          • test
          Note   

          Repeat this step to add additional profile alert groups if required.

           
          Step 7 UCSC(policy-mgr) /domain-group/callhome/profile* # remove alertgroups alert-group   (Optional)

          Removes a specific profile alert groups from the buffer:

          • ciscotac
          • diagnostic
          • environmental
          • inventory
          • license
          • lifecycle
          • linecard
          • supervisor
          • syslogport
          • system
          • test
          Note   

          Repeat this step to remove additional profile alert groups if required.

           
          Step 8 UCSC(policy-mgr) /domain-group/callhome/profile* # clear alertgroups   (Optional)

          Clears all profile alert groups from the buffer.

           
          Step 9 UCSC(policy-mgr) /domain-group/callhome/profile* # set format format  

          Sets the format:

          • fulltxt
          • shorttxt
          • xml
           
          Step 10 UCSC(policy-mgr) /domain-group/callhome/profile* # set level level  

          Sets the level:

          • critical
          • debug
          • disaster
          • fatal
          • major
          • minor
          • normal
          • notification
          • warning
           
          Step 11 UCSC(policy-mgr) /domain-group/callhome/profile* # set maxsize maximum-size  

          Sets the maximum size in megabytes (0-5000000).

           
          Step 12 UCSC(policy-mgr) /domain-group/callhome/profile* # create | delete | scope destination destination-name | destination-email  

          Creates, deletes, or scopes the profile destination name or email address.

           
          Step 13 UCSC(policy-mgr) /domain-group/callhome/profile/destination* # commit-buffer  

          Commits the transaction to the system configuration.

           

          The following example shows how to scope into the domain group domaingroup01, scope the Call Home policy, scope the policy profile chprofile01, configure the policy profile, and commit the transaction:

          UCSC # connect policy-mgr
          UCSC(policy-mgr)# scope domain-group domaingroup01
          UCSC(policy-mgr) /domain-group # scope callhome
          UCSC(policy-mgr) /domain-group/callhome # scope profile chprofile01
          UCSC(policy-mgr) /domain-group/callhome/profile # set alertgroups diagnostic
          UCSC(policy-mgr) /domain-group/callhome/profile* # add alertgroups lifecycle
          UCSC(policy-mgr) /domain-group/callhome/profile* # set level normal
          UCSC(policy-mgr) /domain-group/callhome/profile* # set maxsize 5000000
          UCSC(policy-mgr) /domain-group/callhome/profile* # create destination destination@cisco.com
          UCSC(policy-mgr) /domain-group/callhome/profile/destination* # commit-buffer
          UCSC(policy-mgr) /domain-group/callhome/profile/destination # 
          

          Deleting a Profile for a Call Home Policy

          Procedure
              Command or Action Purpose
            Step 1 UCSC# connect policy-mgr  

            Enters policy manager mode.

             
            Step 2 UCSC(policy-mgr)# scope domain-group domain-group  

            Enters domain group root mode and (optionally) enters a domain group under the domain group root. To enter the domain group root mode, type / as the domain-group.

             
            Step 3 UCSC(policy-mgr) /domain-group # scope callhome  

            Scopes the default Call Home policy's configuration mode.

             
            Step 4 UCSC(policy-mgr) /domain-group/callhome # delete profile profile-name  

            Deletes a Call Home policy's profile.

             
            Step 5 UCSC(policy-mgr) /domain-group/callhome* # commit-buffer  

            Commits the transaction to the system configuration.

             

            The following example shows how to scope into the domain group domaingroup01, scope the Call Home policy, delete the policy profile chprofile01, and commit the transaction:

            UCSC # connect policy-mgr
            UCSC(policy-mgr)# scope domain-group domaingroup01
            UCSC(policy-mgr) /domain-group # scope callhome
            UCSC(policy-mgr) /domain-group/callhome # delete profile chprofile01
            UCSC(policy-mgr) /domain-group/callhome* # commit-buffer
            UCSC(policy-mgr) /domain-group/callhome # 
            

            Configuring a Policy for a Call Home Policy

            Before configuring a policy for a call home policy under a domain group, this policy must first be created. Policies for call home policies under the Domain Groups root that were already created by the system are ready to configure.

            Before You Begin

            Create a Call Home Policy.

            Procedure
                Command or Action Purpose
              Step 1 UCSC# connect policy-mgr  

              Enters policy manager mode.

               
              Step 2 UCSC(policy-mgr)# scope domain-group domain-group  

              Enters domain group root mode and (optionally) enters a domain group under the domain group root. To enter the domain group root mode, type / as the domain-group.

               
              Step 3 UCSC(policy-mgr) /domain-group # scope callhome  

              Scopes the default Call Home policy's configuration mode.

               
              Step 4 UCSC(policy-mgr) /domain-group/callhome # create | scope policy policy-name  

              Creates a policy for a Call Home policy and enters that policy's mode, or scopes an existing policy for a Call Home policy.

              Policies for the Call Home policy include:

              • arp-targets-config-error
              • association-failed
              • configuration-failure
              • connectivity-problem
              • election-failure
              • equipment-disabled
              • equipment-inaccessible
              • equipment-inoperable
              • equipment-offline
              • equipment-problem
              • fru-problem
              • identity-unestablishable
              • inventory-failed
              • license-graceperiod-expired
              • limit-reached
              • link-down
              • management-services-failure
              • management-services-unresponsive
              • mgmtif-down
              • port-failed
              • power-problem
              • thermal-problem
              • version-incompatible
              • vif-ids-mismatch
              • voltage-problem
               
              Step 5 UCSC(policy-mgr) /domain-group/callhome/policy* # enable | disable  

              Enables or disables the policy for the Call Home policy.

               
              Step 6 UCSC(policy-mgr) /domain-group/callhome/policy* # set admin-state enabled | disabled  

              Enables or disables the admin state of the policy for the Call Home policy.

               
              Step 7 UCSC(policy-mgr) /domain-group/callhome/policy* # exit   (Optional)

              Moves up one level to create or scope and configure the next policy for the Call Home policy. Repeating the above three steps until all required policies for the Call Home policy are scoped or created and configured.

               
              Step 8 UCSC(policy-mgr) /domain-group/callhome/profile/destination* # commit-buffer  

              Commits the transaction to the system configuration.

               

              The following example shows how to scope into the domain group domaingroup01, scope the Call Home policy, recursively create policies license-graceperiod-expired and management-services-failure, enable these policies for the Call Home policy, enable the admin-state for each, and commit the transaction:

              UCSC # connect policy-mgr
              UCSC(policy-mgr)# scope domain-group domaingroup01
              UCSC(policy-mgr) /domain-group # scope callhome
              UCSC(policy-mgr) /domain-group/callhome # create policy license-graceperiod-expired
              UCSC(policy-mgr) /domain-group/callhome/policy* # enable
              UCSC(policy-mgr) /domain-group/callhome/policy* # set admin-state enable
              UCSC(policy-mgr) /domain-group/callhome/policy* # exit
              UCSC(policy-mgr) /domain-group/callhome # create policy management-services-failure
              UCSC(policy-mgr) /domain-group/callhome/policy* # enable
              UCSC(policy-mgr) /domain-group/callhome/policy* # set admin-state enable
              UCSC(policy-mgr) /domain-group/callhome/policy* # commit-buffer
              UCSC(policy-mgr) /domain-group/callhome/policy # 
              
              

              The following example shows how to scope into the domain group domaingroup01, scope the Call Home policy, recursively scope existing policies connectivity-problem, management-services-unresponsive, and thermal-problem, enable these policies for the Call Home policy, enable the admin-state for each, and commit the transaction:

              UCSC # connect policy-mgr
              UCSC(policy-mgr)# scope domain-group domaingroup01
              UCSC(policy-mgr) /domain-group # scope callhome
              UCSC(policy-mgr) /domain-group/callhome # scope policy connectivity-problem
              UCSC(policy-mgr) /domain-group/callhome/policy # enable
              UCSC(policy-mgr) /domain-group/callhome/policy* # set admin-state enable
              UCSC(policy-mgr) /domain-group/callhome/policy* # exit
              UCSC(policy-mgr) /domain-group/callhome* # scope policy management-services-unresponsive
              UCSC(policy-mgr) /domain-group/callhome/policy* # enable
              UCSC(policy-mgr) /domain-group/callhome/policy* # set admin-state enable
              UCSC(policy-mgr) /domain-group/callhome/policy* # exit
              UCSC(policy-mgr) /domain-group/callhome* # scope policy thermal-problem
              UCSC(policy-mgr) /domain-group/callhome/policy* # enable
              UCSC(policy-mgr) /domain-group/callhome/policy* # set admin-state enable
              UCSC(policy-mgr) /domain-group/callhome/policy* # commit-buffer
              UCSC(policy-mgr) /domain-group/callhome/policy # 
              

              Deleting a Policy for a Call Home Policy

              Procedure
                  Command or Action Purpose
                Step 1 UCSC# connect policy-mgr  

                Enters policy manager mode.

                 
                Step 2 UCSC(policy-mgr)# scope domain-group domain-group  

                Enters domain group root mode and (optionally) enters a domain group under the domain group root. To enter the domain group root mode, type / as the domain-group.

                 
                Step 3 UCSC(policy-mgr) /domain-group # scope callhome  

                Scopes the default Call Home policy's configuration mode.

                 
                Step 4 UCSC(policy-mgr) /domain-group/callhome # delete policy policy-name  

                Deletes a policy for a Call Home policy.

                 
                Step 5 UCSC(policy-mgr) /domain-group/callhome* # commit-buffer  

                Commits the transaction to the system configuration.

                 

                The following example shows how to scope into the domain group domaingroup01, scope the Call Home policy, delete the policy chpolicy01 from within the Call Home policy, and commit the transaction:

                UCSC # connect policy-mgr
                UCSC(policy-mgr)# scope domain-group domaingroup01
                UCSC(policy-mgr) /domain-group # scope callhome
                UCSC(policy-mgr) /domain-group/callhome # delete policy chpolicy01
                UCSC(policy-mgr) /domain-group/callhome* # commit-buffer
                UCSC(policy-mgr) /domain-group/callhome #