Configuring Administrative Operations

This section includes the following topics:

Administrative Operation Conventions

The following conventions apply when performing the administrative operations described in this section:

  • The remote file location you specify must start with a slash (/) and include the full path and file name. Do not use relative paths.

  • The user name and password on the remote system must be correct, and the user specified must have read and write permissions on the remote system.

  • The file on the remote system must be a valid file, and the size cannot be zero.

  • For backup and export operations, if the Task tab contains a Remote Err Description of No such file, reboot the VM via vCenter.

Managing Backup Operations

We recommend that you use backup and restore operation as a disaster recovery mechanism. To migrate configuration data from one server to another, use export and import operations.

Creating a Backup Operation

Before You Begin

Obtain the backup server IP address or hostname and authentication credentials.

SUMMARY STEPS

    1.    Choose Administration > Operations.

    2.    Click Create Backup Operation.

    3.    In the Create Backup Operation dialog box, complete the following fields, then click OK:


DETAILED STEPS
    Step 1   Choose Administration > Operations.
    Step 2   Click Create Backup Operation.
    Step 3   In the Create Backup Operation dialog box, complete the following fields, then click OK:
    Field Description

    Admin State

    One of the following administrative states:

    • enabled—Backup is enabled. The system runs the backup operation when you click OK.

    • disabled—Backup is disabled. The system does not run the backup operation when you click OK. If you choose this option, all fields in the dialog box remain visible.

    Type

    Backup type.

    The backup creates a copy of the whole database file. You can use this file for disaster recovery if you need to recreate every configuration on your system. This field is not editable.

    Protocol

    Protocol used when communicating with the remote server:

    • FTP

    • SCP

    • SFTP

    Hostname/IP Address

    Hostname or IP address of the device where the backup file is stored.

    This entry cannot be changed when editing the operation.

    If you use a hostname instead of an IP address, you must configure a DNS server.

    User

    Username the system uses to log into the remote server.

    Password

    Password the system uses to log into the remote server.

    This field is displayed if you choose enabled in the Admin State field.

    does not store this password. You do not need to enter this password unless you intend to enable and run the backup operation immediately.

    Absolute Path Remote File

    Full path of the backup filename.

    This entry must start with a slash (/) and must not contain a relative path.

    Running a Backup Operation

    SUMMARY STEPS

      1.    Choose Administration > Operations > Backup-server where backup-server is the server on which the backup file is stored.

      2.    In the General tab, enter the following information:

      3.    Click Save.

      4.    (Optional) To view the progress of the backup operation, click the Task tab. The Task tab provides the information described in the following table. The operation continues to run until it is completed.


    DETAILED STEPS
      Step 1   Choose Administration > Operations > Backup-server where backup-server is the server on which the backup file is stored.
      Step 2   In the General tab, enter the following information:
      1. In the Admin State field, choose enabled.
      2. (Optional) Change the content of the other available fields.
      Step 3   Click Save.

      takes a snapshot of the configuration type that you selected and uploads the file to the network location.

      Step 4   (Optional) To view the progress of the backup operation, click the Task tab. The Task tab provides the information described in the following table. The operation continues to run until it is completed.
      Field Description

      Description

      Task description.

      Status

      Task status.

      Stage Descriptor

      Description of the current stage.

      Tries

      Number of times the task has been tried.

      Previous Status

      Status of the previous task only.

      This field does not provide the status of the current task.

      Remote Err Code

      Remote error code.

      Remote Err Description

      Description of the remote error.

      Remote Inv Result

      Remote error result.

      Time Stamp

      Date and time when the task completed.

      Progress

      Progress of the current task, indicated by the percent complete, a progress bar, or both.

      Editing a Backup Operation

      Before You Begin

      Obtain the backup server IP address or hostname and authentication credentials.

      SUMMARY STEPS

        1.    Choose Administration > Operations.

        2.    Select the backup operation you want to edit, then click Edit.

        3.    In the Edit Backup dialog box, modify the information as required, then click OK.


      DETAILED STEPS
        Step 1   Choose Administration > Operations.
        Step 2   Select the backup operation you want to edit, then click Edit.
        Step 3   In the Edit Backup dialog box, modify the information as required, then click OK.
        Field Description

        Admin State

        One of the following administrative states:

        • enabled—Backup is enabled. The system runs the backup operation when you click OK.

        • disabled—Backup is disabled. The system does not run the backup operation when you click OK. If you choose this option, all fields in the dialog box remain visible.

        Type

        Backup type.

        The backup creates a copy of the whole database file. You can use this file for disaster recovery if you need to recreate every configuration on your system. This field is not editable.

        Protocol

        Protocol used when communicating with the remote server:

        • FTP

        • SCP

        • SFTP

        Hostname/IP Address

        Hostname or IP address of the device where the backup file is stored.

        This entry cannot be changed when editing the operation.

        If you use a hostname instead of an IP address, you must configure a DNS server.

        User

        Username the system uses to log into the remote server.

        Password

        Password the system uses to log into the remote server.

        This field is displayed if you choose enabled in the Admin State field.

        does not store this password. You do not need to enter this password unless you intend to enable and run the backup operation immediately.

        Absolute Path Remote File

        Full path of the backup filename.

        This entry must start with a slash (/) and must not contain a relative path.

        Deleting a Backup Operation

        SUMMARY STEPS

          1.    Choose Administration > Operations.

          2.    Select the backup operation you want to delete, then click Delete.

          3.    When prompted, confirm the deletion.


        DETAILED STEPS
          Step 1   Choose Administration > Operations.
          Step 2   Select the backup operation you want to delete, then click Delete.
          Step 3   When prompted, confirm the deletion.

          Restoring a Backup Configuration

          SUMMARY STEPS

            1.    Install the virtual machine.

            2.    Uninstall the VSG policy agents. Connect the Secure Shell to the VSG console for this task. This step does not disrupt traffic.

            3.    Disable the ASA 1000V policy agent.

            4.    Uninstall the VSM policy agents. Connect the Secure Shell to the VSM console for this task. This step does not disrupt traffic.

            5.    Restore the database. Connect the Secure Shell to the CLI for this task. Depending upon your backup location, restore using FTP, SCP, or SFTP.

            6.    In the GUI, choose Resource Management > Resources > VSMs, and do the following:

            7.    In the GUI, choose Resource Management > Resources > VSMs, and verify that the deleted VSMs are not displayed.

            8.    Reregister the VSMs associated with by entering the following commands for each VSM:

            9.    Reinstall the VSM policy agents.

            10.    Wait until all the VSMs have registered with and are displayed under Resource Management > Resources > VSMs.

            11.    Reregister the VSGs associated with by entering the following commands for each VSG:

            12.    Reinstall the VSG policy agents.

            13.    Re-enable the ASA 1000V policy agent.

            14.    Verify the following states after the restore process is complete:


          DETAILED STEPS
            Step 1   Install the virtual machine.
            Step 2   Uninstall the VSG policy agents. Connect the Secure Shell to the VSG console for this task. This step does not disrupt traffic.
            Note    Perform this step for all VSGs that are associated with the that you are restoring.


            Example:

            VMware

            vsg# conf t

            vsg(config)# vnmc-policy-agent

            vsg(config-vnmc-policy-agent)# no policy-agent-image

            Hyper-V Hypervisor

            vsg# conf t

            vsg(config)# nsc-policy-agent

            vsg(config-nsc-policy-agent)# no policy-agent-image

            Step 3   Disable the ASA 1000V policy agent.

            Example:

            VMware

            asa# conf t

            asa(config)# no vnmc policy-agent

            Hyper-V Hypervisor

            Not available.

            Step 4   Uninstall the VSM policy agents. Connect the Secure Shell to the VSM console for this task. This step does not disrupt traffic.
            Note    Perform this step for all VSMs that are associated with the you are restoring.


            Example:

            VMware

            vsm# conf t

            vsm(config)# vnmc-policy-agent

            vsm(config-vnmc-policy-agent)# no policy-agent-image

            Hyper-V Hypervisor

            vsm# conf t

            vsm(config)# nsc-policy-agent

            vsm(config-nsc-policy-agent)# no policy-agent-image

            Step 5   Restore the database. Connect the Secure Shell to the CLI for this task. Depending upon your backup location, restore using FTP, SCP, or SFTP.

            Example:

            nsc# connect local-mgmt

            nsc(local-mgmt)# restore scp://username@server/path

            Step 6   In the GUI, choose Resource Management > Resources > VSMs, and do the following:
            1. Wait until each registered VSM displays the operational status of lost-visibility.
            2. Choose each VSM, and click Delete.
            Step 7   In the GUI, choose Resource Management > Resources > VSMs, and verify that the deleted VSMs are not displayed.
            Step 8   Reregister the VSMs associated with by entering the following commands for each VSM:

            Example:

            VMware

            vsm# conf t

            vsm(config)# vnmc-policy-agent

            vsm(config-vnmc-policy-agent)# registration-ip PrimeNSC-ip-address

            vsm(config-vnmc-policy-agent)# shared-secret password

            Hyper-V Hypervisor

            vsm# conf t

            vsm(config)# nsc-policy-agent

            vms(config-nsc-policy-agent)# registration-ip PrimeNSC-ip-address

            vsm(config-nsc-policy-agent)# shared-secret password

            Step 9   Reinstall the VSM policy agents.
            Note    If the VSM policy agents must be upgraded, install the new software now.   


            Example:

            VMware

            vsm# conf t

            vsm(config)# vnmc-policy-agent

            vsm(config-vnmc-policy-agent)# policy-agent-image bootflash:nsc-vsmpa.n.n.n.bin

            Hyper-V Hypervisor

            vsm# conf t

            vms(config)# nsc-policy-agent

            vsm(config-nsc-policy-agent)# policy-agent-image bootflash:nsc-vsmpa.n.n.n.bin

            Step 10   Wait until all the VSMs have registered with and are displayed under Resource Management > Resources > VSMs.
            Step 11   Reregister the VSGs associated with by entering the following commands for each VSG:

            Example:

            VMware

            vsg# conf t

            vsg(config)# vnmc-policy-agent

            vsg(config-vnmc-policy-agent)# registration-ip PrimeNSC-ip-address

            vsg(config-vnmc-policy-agent)# shared-secret password

            Hyper-V Hypervisor

            vsg# conf t

            vsg(config)# nsc-policy-agent

            vsg(config-nsc-policy-agent)# registration-ip PrimeNSC-ip-address

            vsg(config-nsc-policy-agent)# shared-secret password

            Step 12   Reinstall the VSG policy agents.
            Note    If the VSG policy agents must be upgraded, install the new software now.    


            Example:

            VMware

            vsg# conf t

            vsg(config)# vnmc-policy-agent

            vsg(config-vnmc-policy-agent)# policy-agent-image bootflash:nsc-vsgpa.n.n.n.bin

            Hyper-V Hypervisor

            vsg# conf t

            vsg(config)# nsc-policy-agent

            vsg(config-nsc-policy-agent)# policy-agent-image bootflash:nsc-vsgpa.n.n.n.bin

            Step 13   Re-enable the ASA 1000V policy agent.

            Example:

            VMware

            asa# conf t

            asa(config)# vnmc policy-agent

            asa(config-vnmc-policy-agent)# shared-secret password

            asa(config-vnmc-policy-agent)# registration host PrimeNSC-ip-address

            Hyper-V Hypervisor

            Not available.

            Step 14   Verify the following states after the restore process is complete:
            Note    The restore process could take a few minutes depending upon your setup environment.
            1. Using the VSG CLI, verify that your configurations are restored to their earlier state.
            2. Using the GUI, verify that your objects and policies are restored to their earlier state.
            3. Using the ASA 1000V CLI, verify that your configurations are restored to their earlier state.

            Managing Export Operations

            Use export and import operations to migrate data from one server to another. To back up and restore data (for example, as a disaster recovery mechanism), use backup and restore operations.

            Creating an Export Operation

            The associations of compute and edge firewalls with VSGs and ASA 1000Vs, respectively, are not included in export or import data. Only firewall definitions are included, such as device profiles and policies. If an imported firewall did not exist in the system, it will not be associated to a VSG or ASA 1000V after the import operation. If an imported firewall already existed in the system, the association state remains the same.

            Before You Begin

            Obtain the remote file server IP address or hostname and authentication credentials before performing an export.

            SUMMARY STEPS

              1.    Choose Administration > Operations.

              2.    Click Create Export Operation.

              3.    In the Create Export Operation dialog box, provide the required information as described in the following table, then click OK:


            DETAILED STEPS
              Step 1   Choose Administration > Operations.
              Step 2   Click Create Export Operation.
              Step 3   In the Create Export Operation dialog box, provide the required information as described in the following table, then click OK:
              Field Description

              Admin State

              One of the following administrative states:

              • enabled—Export is enabled. The system runs the export operation when you click OK.

              • disabled—Export is disabled. The system does not run the export operation when you click OK. If you choose this option, all fields in the dialog box remain visible.

              Type

              One of the following export types:

              • config-all

              • config-logical

              • config-system

              Protocol

              Protocol used when communicating with the remote server:

              • FTP

              • SCP

              • SFTP

              Hostname/IP Address

              Hostname or IP address of the device where the export file is stored.

              This entry cannot be changed when editing the operation.

              If you use a hostname instead of an IP address, you must configure a DNS server.

              User

              Username the system uses to log into the remote server.

              Password

              The password the system uses to log into the remote server.

              This field is displayed if you choose enabled in the Admin State field.

              does not store this password. You do not need to enter this password unless you intend to enable and run the export operation immediately.

              Absolute Path Remote File (.tgz)

              Full path of the .tgz filename.

              This entry must start with a slash (/) and must not contain a relative path.

              Editing an Export Operation


              Note
              The associations of compute and edge firewalls with VSGs and ASA 1000Vs, respectively, are not included in export or import data. Only firewall definitions are included, such as device profiles and policies. If an imported firewall did not exist in the system, it will not be associated to a VSG or ASA 1000V after the import operation. If an imported firewall already existed in the system, the association state remains the same.
              Before You Begin

              Obtain the remote file server IP address or hostname and authentication credentials before performing an export.

              SUMMARY STEPS

                1.    Choose Administration > Operations.

                2.    In the Operations table, select the export operation you want to edit, then click Edit.

                3.    In the Edit Export dialog box, modify the fields as appropriate, then click OK.


              DETAILED STEPS
                Step 1   Choose Administration > Operations.
                Step 2   In the Operations table, select the export operation you want to edit, then click Edit.
                Step 3   In the Edit Export dialog box, modify the fields as appropriate, then click OK.
                Field Description

                Admin State

                One of the following administrative states:

                • enabled—Export is enabled. The system runs the export operation when you click OK.

                • disabled—Export is disabled. The system does not run the export operation when you click OK. If you choose this option, all fields in the dialog box remain visible.

                Type

                One of the following export types:

                • config-all

                • config-logical

                • config-system

                Protocol

                Protocol used when communicating with the remote server:

                • FTP

                • SCP

                • SFTP

                Hostname/IP Address

                Hostname or IP address of the device where the export file is stored.

                This entry cannot be changed when editing the operation.

                If you use a hostname instead of an IP address, you must configure a DNS server.

                User

                Username the system uses to log into the remote server.

                Password

                The password the system uses to log into the remote server.

                This field is displayed if you choose enabled in the Admin State field.

                does not store this password. You do not need to enter this password unless you intend to enable and run the export operation immediately.

                Absolute Path Remote File (.tgz)

                Full path of the .tgz filename.

                This entry must start with a slash (/) and must not contain a relative path.

                Deleting an Export Operation

                SUMMARY STEPS

                  1.    In the Navigation pane, choose Administration > Operations.

                  2.    In the Operations table, select the export operation you want to delete.

                  3.    When prompted, confirm the deletion.


                DETAILED STEPS
                  Step 1   In the Navigation pane, choose Administration > Operations.
                  Step 2   In the Operations table, select the export operation you want to delete.
                  Step 3   When prompted, confirm the deletion.

                  Configuring Import Operations

                  Creating an Import Operation

                  Before You Begin

                  Obtain the remote file server IP address or hostname and authentication credentials.


                  Note
                  The association of compute and edge firewalls with VSGs and ASA 1000Vs, respectively, are not included in the export or import data. Only the compute and edge firewall definitions are included, such as device profiles and policies. Therefore, if an imported firewall did not exist in the system, it will not be associated to a VSG or ASA 1000V after the import operation. If an imported firewall already existed in the system, the association state remains the same.


                  Caution
                  When the configuration data is imported into the server, you might see an error message and get logged out, followed by the display of a new certificate. This error occurs because the hostname, domain name, or both have changed. The VM Manager Extension needs to be exported again and installed on vCenter. To continue with the import, accept the certificate and log into again.
                  SUMMARY STEPS

                    1.    Choose Administration > Operations.

                    2.    Click Create Import Operation.

                    3.    In the Create Import Operation dialog box, provide the following information as required, then click OK:


                  DETAILED STEPS
                    Step 1   Choose Administration > Operations.
                    Step 2   Click Create Import Operation.
                    Step 3   In the Create Import Operation dialog box, provide the following information as required, then click OK:
                    Field Description

                    Admin State

                    One of the following administrative states:

                    • enabled—Import is enabled. The system runs the import operation as soon as you click OK.

                    • disabled—Import is disabled. The system does not run the import operation when you click OK. If you choose this option, all fields in the dialog box remain visible.

                    Action

                    Action to be taken on a file: merge.

                    Protocol

                    Protocol used when communicating with the remote server:

                    • FTP

                    • SCP

                    • SFTP

                    Hostname/IP Address

                    Hostname or IP address of the device where the import file is stored.

                    This entry cannot be changed when editing the operation.

                    If you use a hostname instead of an IP address, you must configure a DNS server.

                    User

                    Username the system uses to log into the remote server.

                    This field is displayed if you choose enabled in the Admin State field.

                    Password

                    Password the system uses to log into the remote server.

                    does not store this password. You do not need to enter this password unless you intend to enable and run the import operation immediately.

                    Absolute Path Remote File (.tgz)

                    Full path of the .tgz filename.

                    This entry must start with a slash (/) and must not contain a relative path.

                    Editing an Import Operation

                    Before You Begin

                    Obtain the remote file server IP address or hostname and authentication credentials.

                    SUMMARY STEPS

                      1.    Choose Administration > Operations.

                      2.    Select the import operation that you want to edit, then click Edit.

                      3.    In the Edit dialog box, modify the fields as required, then click OK.


                    DETAILED STEPS
                      Step 1   Choose Administration > Operations.
                      Step 2   Select the import operation that you want to edit, then click Edit.
                      Step 3   In the Edit dialog box, modify the fields as required, then click OK.
                      Field Description

                      Admin State

                      One of the following administrative states:

                      • enabled—Import is enabled. The system runs the import operation as soon as you click OK.

                      • disabled—Import is disabled. The system does not run the import operation when you click OK. If you choose this option, all fields in the dialog box remain visible.

                      Action

                      Action to be taken on a file: merge.

                      Protocol

                      Protocol used when communicating with the remote server:

                      • FTP

                      • SCP

                      • SFTP

                      Hostname/IP Address

                      Hostname or IP address of the device where the import file is stored.

                      This entry cannot be changed when editing the operation.

                      If you use a hostname instead of an IP address, you must configure a DNS server.

                      User

                      Username the system uses to log into the remote server.

                      This field is displayed if you choose enabled in the Admin State field.

                      Password

                      Password the system uses to log into the remote server.

                      does not store this password. You do not need to enter this password unless you intend to enable and run the import operation immediately.

                      Absolute Path Remote File (.tgz)

                      Full path of the .tgz filename.

                      This entry must start with a slash (/) and must not contain a relative path.

                      Deleting an Import Operation

                      SUMMARY STEPS

                        1.    Choose Administration > Operations.

                        2.    Select the import operation that you want to delete, then click Delete.

                        3.    When prompted, confirm the deletion.


                      DETAILED STEPS
                        Step 1   Choose Administration > Operations.
                        Step 2   Select the import operation that you want to delete, then click Delete.
                        Step 3   When prompted, confirm the deletion.