Cisco-IOS-XR-install-augmented-act

This module contains a augmented collection of YANG definitions for Cisco IOS-XR install actions, and should be used along with ...

  • Version: 2020-08-03

    Cisco-IOS-XR-install-augmented-act@2020-08-03


    
      module Cisco-IOS-XR-install-augmented-act {
    
        yang-version 1;
    
        namespace
          "http://cisco.com/ns/yang/Cisco-IOS-XR-install-augmented-act";
    
        prefix install-augmented-act;
    
        import cisco-semver {
          prefix semver;
        }
        import Cisco-IOS-XR-types {
          prefix csc;
        }
        import Cisco-IOS-XR-install-act {
          prefix install-act;
        }
    
        organization "Cisco Systems, Inc.";
    
        contact
          "Cisco Systems, Inc.
         Customer Service
         
         Postal: 170 West Tasman Drive
         San Jose, CA 95134
         
         Tel: +1 800 553-NETS
         
         E-mail: cs-yang@cisco.com";
    
        description
          "This module contains a augmented collection of YANG definitions for Cisco
         IOS-XR install actions, and should be used along with
         Cisco-IOS-XR-install-act.yang
         
         Copyright (c) 2016-2020 by Cisco Systems, Inc.
         All rights reserved.";
    
        revision "2020-08-03" {
          description
            "Modified tasks for the RPC operations.";
        }
    
        revision "2020-03-06" {
          description
            "Removal of the install-reload-failed-nodes RPC
           2019-11-05
           Addition of INST-AUGMENTED-OP-ID-TYPE for the return type of action RPCs";
        }
    
        revision "2019-10-03" {
          description
            "Move apply type enum to Cisco-IOS-XR-install-act.yang
           2019-10-01
           Made changes to be RFC6087 compliant
           2019-09-19
           Allow user to indicate apply-type at the beginning of an operation.";
        }
    
        revision "2019-04-05" {
          description
            "Establish semantic version baseline.";
        }
    
        revision "2018-10-05" {
          description "IOS XR 7.0.1 revision.";
        }
    
        semver:module-version "3.1.0";
        semver:module-version "3.0.0";
        semver:module-version "2.0.0";
        semver:module-version "1.0.0";
    
        typedef abort-type {
          type enumeration {
            enum "latest" {
              value 0;
              description
                "Abort the latest packaging operation";
            }
            enum "all-since-apply" {
              value 1;
              description
                "Abort all packaging operations since the last apply";
            }
          }
          description "abort type";
        }
    
        rpc install-package-add {
          csc:xr-task "pkg-mgmt";
          description
            "Add all packages in a specified source, or the given list of packages";
          input {
            container packages {
              description
                "List of packages to add, or empty to add all packages";
              leaf-list packagename {
                type string;
                description "package name";
              }
            }  // container packages
    
            leaf source-type {
              type install-act:packages-source-type;
              default
                "any-configured-repository";
              description
                "Type of source used to obtain the packages";
            }
    
            leaf source {
              type string;
              description
                "Path to the location of the packages.  If source-type is
               'any-configured-repository' this field is unused, and if
               source-type is 'configured-repository' this should be the
               name of the repository to use.";
            }
          }
    
          output {
            leaf op-id {
              type string;
              description
                "operation id of the triggered action";
            }
          }
        }  // rpc install-package-add
    
        rpc install-package-remove {
          csc:xr-task "pkg-mgmt";
          description
            "Remove the given list of packages";
          input {
            container packages {
              description
                "List of packages to remove";
              leaf-list packagename {
                type string;
                description "package name";
              }
            }  // container packages
          }
    
          output {
            leaf op-id {
              type string;
              description
                "operation id of the triggered action";
            }
          }
        }  // rpc install-package-remove
    
        rpc install-package-upgrade {
          csc:xr-task "pkg-mgmt";
          description
            "Upgrade all packages, or the given list of packages";
          input {
            container packages {
              description
                "List of packages to upgrade, or empty to upgrade all packages";
              leaf-list packagename {
                type string;
                description "package name";
              }
            }  // container packages
    
            leaf source-type {
              type install-act:packages-source-type;
              default
                "any-configured-repository";
              description
                "Type of source used to obtain the packages";
            }
    
            leaf source {
              type string;
              description
                "Path to the location of the packages.  If source-type is
               'any-configured-repository' this field is unused, and if
               source-type is 'configured-repository' this should be the
               name of the repository to use.";
            }
          }
    
          output {
            leaf op-id {
              type string;
              description
                "operation id of the triggered action";
            }
          }
        }  // rpc install-package-upgrade
    
        rpc install-package-downgrade {
          csc:xr-task "pkg-mgmt";
          description
            "Downgrade all packages in a specified source, or the given list of
           packages";
          input {
            container packages {
              description
                "List of packages to downgrade, or empty to downgrade all packages
               in a specified source";
              leaf-list packagename {
                type string;
                description "package name";
              }
            }  // container packages
    
            leaf source-type {
              type install-act:packages-source-type;
              default
                "any-configured-repository";
              description
                "Type of source used to obtain the packages";
            }
    
            leaf source {
              type string;
              description
                "Path to the location of the packages.  If source-type is
               'any-configured-repository' this field is unused, and if
               source-type is 'configured-repository' this should be the
               name of the repository to use.";
            }
          }
    
          output {
            leaf op-id {
              type string;
              description
                "operation id of the triggered action";
            }
          }
        }  // rpc install-package-downgrade
    
        rpc install-package-replace {
          csc:xr-task "pkg-mgmt";
          description
            "Replace the current installed software";
          input {
            leaf source-type {
              type install-act:replace-source-type;
              default "local";
              description
                "Type of source used to obtain the ISO";
            }
    
            leaf source {
              type string;
              mandatory true;
              description
                "Path to the location of the ISO";
            }
    
            leaf file {
              type string;
              mandatory true;
              description
                "Name of the ISO to install";
            }
          }
    
          output {
            leaf op-id {
              type string;
              description
                "operation id of the triggered action";
            }
          }
        }  // rpc install-package-replace
    
        rpc install-package-rollback {
          csc:xr-task "pkg-mgmt";
          description
            "Rollback the installed software to a previous revision";
          input {
            leaf transaction-id {
              type uint32;
              mandatory true;
              description
                "Transaction ID to rollback to";
            }
          }
    
          output {
            leaf op-id {
              type string;
              description
                "operation id of the triggered action";
            }
          }
        }  // rpc install-package-rollback
    
        rpc install-rollback {
          csc:xr-task "pkg-mgmt";
          description
            "Rollback the installed software to a previous revision and apply the change";
          input {
            leaf transaction-id {
              type uint32;
              mandatory true;
              description
                "Transaction ID to rollback to";
            }
    
            leaf commit {
              type boolean;
              default "false";
              description
                "Commit at the end of the rollback operation, if the
               software is successfully applied";
            }
    
            leaf description {
              type string;
              description
                "Description to be stored for the transaction ID";
            }
    
            leaf activation-type {
              type install-act:apply-type;
              default "least-impactful";
              description
                "Activate the software using the specified apply type";
            }
          }
    
          output {
            leaf op-id {
              type string;
              description
                "operation id of the triggered action";
            }
          }
        }  // rpc install-rollback
    
        rpc install-apply {
          csc:xr-task "pkg-mgmt";
          description
            "Apply atomic operation by restarting processes or reloading";
          input {
            leaf apply-method {
              type install-act:apply-type;
              mandatory true;
              description
                "Method of applying atomic operation";
            }
          }
    
          output {
            leaf op-id {
              type string;
              description
                "operation id of the triggered action";
            }
          }
        }  // rpc install-apply
    
        rpc install-package-abort {
          csc:xr-task "pkg-mgmt";
          description
            "Abort the specified packaging operation(s)";
          input {
            leaf abort-type {
              type abort-type;
              mandatory true;
              description
                "Which packaging operations to abort";
            }
          }
    
          output {
            leaf op-id {
              type string;
              description
                "operation id of the triggered action";
            }
          }
        }  // rpc install-package-abort
    
        rpc install-label {
          description
            "Label a transaction ID with a description";
          input {
            leaf transaction-id {
              type uint32;
              description
                "Transaction ID to be labelled";
            }
    
            leaf description {
              type string;
              description
                "Description to be stored for the transaction ID";
            }
          }
        }  // rpc install-label
    
        rpc install-clear-rollback {
          csc:xr-task "pkg-mgmt";
          description
            "Remove specified rollback points to save disk space";
          input {
            leaf transaction-id {
              type uint32;
              description
                "Transaction ID corresponding to the rollback point to be removed";
            }
    
            leaf number-of-oldest {
              type uint32;
              description
                "The number of oldest rollback points to be removed";
            }
          }
        }  // rpc install-clear-rollback
      }  // module Cisco-IOS-XR-install-augmented-act
    

© 2023 YumaWorks, Inc. All rights reserved.