Advanced Configurations of the Avi Controller for the Avi Vantage Platform

Creating Avi Controller Alerts

Prerequisites

  • Log in to the Avi Controller as the admin user or with any other user that has the System-Admin role.

Notes:

  • You can choose to apply one or many mechanisms for notifications.

  • Control Scripts are not allowed if the Avi Controller is setup in the Basic edition. For control scripts, the Avi Controller should be setup in the Enterprise edition.

Creating a Syslog Notification Object

The following are the steps to create syslog notification object:

  1. Navigate to the Avi Controller on your browser via  https://sfo-m01-avic01.sfo.rainpole.io.

  2. Navigate to Operations > Notifications > Syslog and click on Create button.

  3. Specify avisyslog as the name  for the syslog notification configuration.

  4. Click on Add Syslog Server option.

  5. Specify syslog server details:
    Setting Value
    Syslog Server IP of the syslog server
    Port Default port used is 514. User can override this setting
  6. Repeat the above steps to add more syslog servers if required.

  7. Click on Save option.

Creating an Email Notification Object

The following are the steps to create an email notification object:

  1. Navigate to the Avi Controller on your browser via  https://sfo-m01-avic01.sfo.rainpole.io.

  2. Navigate to  Operations > Notifications > Email, and click  on Create button.

  3. Specify aviemail as the  name  for the email notification configuration.

  4. Specify the destination emails in the following fields:
    Setting Value
    To Address Email of the primary recipient
    CC Address Comma separated email addresses of secondary recipients
  5. Click on Save option.

Creating a SNMP Notification Object

The following are the steps to create SNMP notification object:

  1. Navigate to the Avi Controller on your browser via  https://sfo-m01-avic01.sfo.rainpole.io.

  2. Navigate to Operations > Notifications > SNMP Trap, and click on Create button.

  3. Specify avisnmp as the name  for the snmp notification configuration.

  4. Specify SNMP server details.

    Setting Value
    Trap Server IP Address IP of the SNMP trap receiver
    SNMP Version SNMP_VER2
    SNMP Community Trap server community string
  5. Click on Add SNMP Server option to add more SNMP servers.

  6. Click on Save option.

Creating a Control Script Object

The following are the steps to create control script object:

  1. Navigate to the Avi Controller on your browser via  https://sfo-m01-avic01.sfo.rainpole.io.

  2. Navigate to Templates > Scripts > ControlScripts and click on Create button.

  3. Specify the name for the control script configuration.

  4. Specify the script in the Enter your ControlScript Here box.

  5. Click on Save option.

Attaching the Syslog, Email and/or SNMP notification Objects to Alerts

The following are the steps to attach the syslog, email and/or SNMP notification objects to alerts:

  1. Navigate to the Avi Controller on your browser via https://sfo-m01-avic01.sfo.rainpole.io.

  2. Navigate to Operations > Alerts > Alert Actions.

  3. Edit the System-Alert-Level-High action.

  4. (Optional) From the Syslog drop-down list, choose avisyslog which was created previously.

  5. (Optional) From the Email drop-down list, choose aviemail which was created previously.

  6. (Optional) From the SNMP Trap drop-down list, choose avisnmp which was created previously.

  7. (Optional) From the ControlScript drop-down list, choose the desired ControlScript.

  8. Click on Save option.

  9. Repeat for System-Alert-Level-Medium and System-Alert-Level-Low.

Creating Custom Roles on the Avi Controller

You can create custom roles on the Avi Controller, only if the pre-existing Roles do not meet the required user-account-permissions criteria.

Prerequisites

  • Three node Avi Controller cluster is setup

Creating a Role

The following are the steps to create a role:

  1. Navigate to the Avi Controller which has been initialized on your browser via sfo-m01-avic01.sfo.rainpole.io.

  2. Navigate to Administration > Accounts > Roles and select on Create option.

  3. Specify the desired Name for the role.

  4. For each permission group, select Read, Write, or No access (Default permission is set to No access).

  5. Click on Save option.

Creating a User and assigning a Role to the User

  1. Navigate to the Avi Controller which has been initialized on your browser via sfo-m01-avic01.sfo.rainpole.io.

  2. Navigate to Administration > Accounts > Users and select on **Create option.

  3. Fill in the following details
    Setting Value
    Name Name of the user
    Username Username used to login to the Avi Controller cluster
    Password Choose a complex password
    Email Email address for the user
  4. (Optional) From the Tenant drop-down field, select the tenant to map to the user (Default tenant mapping is set to the admin tenant)

  5. (Optional) Choose to add multiple Tenants to the user. (Note: This is not applicable if the Avi Controller is setup in the Basic Edition)

  6. From the Role drop-down field, select the role to be assigned to the user.

  7. If multiple tenants are chosen, from the Default Tenant drop-down field, choose the tenant to which the user should be signed into.

  8. Click on Save option.

Upgrade - Patch the Avi Controller Cluster

Prerequisites

Ensure that a full configuration backup is taken before upgrading the Avi Vantage platform.

Note: Only full-system upgrades and patches are allowed if the Avi Controller is setup in the Basic Edition. For flexible upgrades, the Avi Controller should be setup in the Enterprise Edition.

Procedure for System Upgrade

The following are the steps to upgrade a system:

  1. Navigate to the Avi Controller on your browser via sfo-m01-avic01.sfo.rainpole.io.

  2. Navigate to Administration > Controller > Software.

  3. Click on Upload From Computer and choose the Avi Controller .pkg file and click on Open to upload the upgrade package to the image catalogue.

  4. Navigate to Administration > Controller > System Update and choose the uploaded file and click on UPGRADE option.

  5. Select on Upgrade All Service Engine Groups option.

  6. Select Suspend for ACTION TO TAKE ON SEG UPDATE FAILURE and click on Continue and then click on Confirm option.

Avi Controllers will be upgraded first, and then Avi Service Engines will be upgraded on a per Service Engine Group basis.

Procedure to do a Controller only Upgrade

The following are the steps to upgrade the Controller:

  1. Navigate to the Avi Controller on your browser via sfo-m01-avic01.sfo.rainpole.io.

  2. Navigate to Administration > Controller > Software
  3. Click on Upload From Computer and choose the Avi Controller .pkg file and click on Open to upload the upgrade package to the image catalogue.

  4. SSH to the Avi Controller IP using the admin user ssh admin@sfo-m01-avic01.sfo.rainpole.io.

  5. Login to the Avi shell (CLI) by executing shell, specify admin as the username and specify the admin password.

  6. Upgrade only the Avi Controllers by executing upgrade controller image_ref <IMAGE_NAME_FROM_CATALOGUE>.

Procedure to do a SE Group only Upgrade

This method can be used to upgrade only some of the SE Groups on the Avi Controller.

Note: This is used in multi-tenant environments.

The following are the steps to upgrade a SE group:

  1. Navigate to the Avi Controller on your browser via sfo-m01-avic01.sfo.rainpole.io.

  2. Navigate to Administration > Controller > Software.

  3. Click on Upload From Computer and choose the Avi Controller .pkg file and click on Open to upload the upgrade package to the image catalogue.

  4. SSH to the Avi Controller IP using the admin user ssh admin@sfo-m01-avic01.sfo.rainpole.io.

  5. Login to the Avi shell (CLI) by executing shell, specify admin as the username and specify the admin password.

  6. To patch only some of the SE Groups, execute upgrade segroup se_group_refs <SE_GROUP_NAME1> <SE_GROUP_NAME2> image_ref <IMAGE_NAME_FROM_CATALOGUE> (Here SE_GROUP_NAME1 and SE_GROUP_NAME2 are used as an example).

Procedure to do a Patch Upgrade

This method can be used to apply a patch to the following:

  1. Entire cluster (system)
  2. Only the Avi Controllers
  3. Only the Avi Service Engines contained within the specific SE Groups

The following are the steps to upgrade a patch:

  1. Navigate to the Avi Controller on your browser via sfo-m01-avic01.sfo.rainpole.io.

  2. Navigate to Administration > Controller > Software.

  3. Click on Upload From Computer and choose the appropriate patch .pkg file and click on Open to upload the patch package to the image catalogue.

  4. (Optional) You may have to upload multiple patches. For instance, to execute a system patch, both a Controller patch and a SE patch packages need to be uploaded to the catalogue.

  5. SSH to the Avi Controller IP using the admin user ssh admin@sfo-m01-avic01.sfo.rainpole.io.

  6. Login to the Avi shell (CLI) by executing shell, specify admin as the username and specify admin password.

  7. Apply the appropriate patch.

    a. To patch the entire system, execute patch system controller_patch_ref <CONTROLLER_PATCH_NAME_FROM_CATALOGUE> se_patch_ref <SE_PATCH_NAME_FROM_CATALOGUE> code.

    b. To patch only the Avi Controllers, execute patch controller controller_patch_ref <CONTROLLER_PATCH_NAME_FROM_CATALOGUE> code.

    c. To patch only some of the SE Groups, execute patch segroup se_group_refs <SE_GROUP_NAME1> <SE_GROUP_NAME2> se_patch_ref <SE_PATCH_NAME_FROM_CATALOGUE> code (Here SE_GROUP_NAME1 and SE_GROUP_NAME2 are used as an example).