Cisco-IOS-XE-wireless-access-point-cfg-rpc

Copyright (c) 2019-2021 by Cisco Systems, Inc. All rights reserved.

  • Version: 2021-07-01

    Cisco-IOS-XE-wireless-access-point-cfg-rpc@2021-07-01


    
      module Cisco-IOS-XE-wireless-access-point-cfg-rpc {
    
        yang-version 1;
    
        namespace
          "http://cisco.com/ns/yang/Cisco-IOS-XE-wireless-access-point-cfg-rpc";
    
        prefix wireless-access-point-cfg-rpc;
    
        import Cisco-IOS-XE-wireless-enum-types {
          prefix wireless-enum-types;
        }
        import Cisco-IOS-XE-wireless-types {
          prefix wireless-types;
        }
        import ietf-inet-types {
          prefix inet;
        }
        import ietf-yang-types {
          prefix yang;
        }
        import cisco-semver {
          prefix cisco-semver;
        }
    
        organization "Cisco Systems, Inc.";
    
        contact
          "Cisco Systems, Inc.
         Customer Service
    
         Postal: 170 W Tasman Drive
         San Jose, CA 95134
    
         Tel: +1 1800 553-NETS
    
         E-mail: cs-yang@cisco.com";
    
        description
          "Copyright (c) 2019-2021 by Cisco Systems, Inc.
         All rights reserved.";
    
        revision "2021-07-01" {
          description
            "- Modified slot and band range on applicable paths
           - Added option to configure either name or IP address in rpc set-ap-controller";
          reference
            "4.0.0";
    
        }
    
        revision "2021-03-01" {
          description
            "- Changed the pattern for AP name, location and country code.
           - Added AP LAN port configuration";
          reference
            "3.0.0";
    
        }
    
        revision "2020-07-01" {
          description
            "- Added rpc set-ap-controller to configure controller information in access point
           - Added rpc set-ap-cleanair to enable cleanair in access point
           - Added rpc set-ap-slot-phy-ht-customize to configure auto channel selection in access point
           - Added rpc set-ap-slot-phy-ht-chan to configure static channel
           - Added rpc set-ap-mode to configure AP mode.
           - Added must constraint for antenna-band-mode
           - Added range restrictions on leafs slot-id and band on all applicable paths.";
          reference
            "2.0.0";
    
        }
    
        revision "2020-03-01" {
          description "Initial revision";
          reference
            "1.0.0";
    
        }
    
        cisco-semver:module-version "4.0.0";
        cisco-semver:module-version "3.0.0";
        cisco-semver:module-version "2.0.0";
        cisco-semver:module-version "1.0.0";
    
        typedef ap-identifier {
          type enumeration {
            enum "ap-identifier-name" {
              value 0;
              description "Alternative AP name";
            }
            enum "ap-identifier-mac-address" {
              value 1;
              description
                "Alternative MAC address";
            }
          }
          description "Access point identifier";
        }
    
        rpc set-ap-vlan-tag {
          description
            "Configure VLAN tagging for non-bridge AP";
          input {
            leaf vlan-id {
              type uint32;
              mandatory true;
              description "Configure VLAN-ID";
            }
    
            choice alternative-choice {
              mandatory true;
              description
                "AP name or AP MAC address";
              leaf ap-name {
                type string;
                mandatory true;
                description
                  "AP name for VLAN tagging";
              }
              leaf mac-addr {
                type yang:mac-address;
                mandatory true;
                description
                  "MAC address of AP for VLAN tagging";
              }
            }  // choice alternative-choice
          }
        }  // rpc set-ap-vlan-tag
    
        rpc set-ap-monitor-mode-chnl-optimize {
          description
            "Configure channel scanning optimization for AP";
          input {
            leaf mode {
              type wireless-enum-types:lomm-mode-type;
              mandatory true;
              description
                "Select AP mode (none, tracking mode, WIPS mode, all)";
            }
    
            choice alternative-choice {
              mandatory true;
              description
                "AP name or AP MAC address";
              leaf ap-name {
                type string;
                mandatory true;
                description
                  "AP name for channel scanning optimization";
              }
              leaf mac-addr {
                type yang:mac-address;
                mandatory true;
                description
                  "MAC address of AP for channel scanning optimization";
              }
            }  // choice alternative-choice
          }
        }  // rpc set-ap-monitor-mode-chnl-optimize
    
        rpc set-ap-mode {
          description "Configures AP mode";
          input {
            leaf clear-mode {
              type boolean;
              description
                "Restores AP to site tag mode";
            }
    
            leaf mode {
              type wireless-types:enm-ewlc-spam-ap-modes;
              must "(../clear-mode = 'false')" {
                error-message
                  "disable clear mode while configuring mode.";
                error-app-tag "must-violation";
              }
              must "(../mode != 'mode-sensor')" {
                error-message
                  "Sensor mode not supported";
                error-app-tag "must-violation";
              }
              description "Specifies mode of AP";
            }
    
            choice alternative-choice {
              mandatory true;
              description
                "AP name or AP MAC address";
              leaf ap-name {
                type string;
                mandatory true;
                description
                  "Name of AP to configure AP mode";
              }
              leaf mac-addr {
                type yang:mac-address;
                mandatory true;
                description
                  "MAC address of AP to configure AP mode";
              }
            }  // choice alternative-choice
          }
        }  // rpc set-ap-mode
    
        rpc set-lrad-led-state {
          description
            "Set LED-state for Cisco AP";
          input {
            leaf ledstate {
              type boolean;
              mandatory true;
              description
                "Led state of AP can be enabled (true) or disabled (false)";
            }
    
            choice alternative-choice {
              mandatory true;
              description
                "AP name or AP MAC address";
              leaf ap-name {
                type string;
                mandatory true;
                description
                  "Name of AP to configure LED state";
              }
              leaf mac-addr {
                type yang:mac-address;
                mandatory true;
                description
                  "MAC address of AP to configure LED state";
              }
            }  // choice alternative-choice
          }
        }  // rpc set-lrad-led-state
    
        rpc set-ap-location {
          description "Configure AP location";
          input {
            leaf location {
              type string {
                length "1..256";
                pattern '[ -~]+';
              }
              mandatory true;
              description
                "AP location (example sector A or room A)";
            }
    
            choice alternative-choice {
              mandatory true;
              description
                "AP name or AP MAC address";
              leaf ap-name {
                type string;
                mandatory true;
                description
                  "AP name for location change";
              }
              leaf mac-addr {
                type yang:mac-address;
                mandatory true;
                description
                  "MAC address of AP for location change";
              }
            }  // choice alternative-choice
          }
        }  // rpc set-ap-location
    
        rpc set-ap-name {
          description "Configure AP name";
          input {
            leaf name {
              type string {
                length "1..32";
                pattern '[!-~]+';
              }
              mandatory true;
              description "New AP name";
            }
    
            choice alternative-choice {
              mandatory true;
              description
                "AP name or AP MAC address";
              leaf ap-name {
                type string;
                mandatory true;
                description
                  "Existing name of AP to be renamed";
              }
              leaf mac-addr {
                type yang:mac-address;
                mandatory true;
                description
                  "MAC address of AP to be renamed";
              }
            }  // choice alternative-choice
          }
        }  // rpc set-ap-name
    
        rpc set-ap-antenna-band-mode {
          description
            "Configure antenna band mode";
          input {
            leaf band-val {
              type wireless-enum-types:ant-band-mode;
              must
                "../band-val != 'ant-band-mode-unknown'" {
                error-message
                  "ant-band-mode-unknown is not permitted";
                error-app-tag "must-violation";
              }
              mandatory true;
              description
                "Band value can be single or dual";
            }
    
            choice alternative-choice {
              mandatory true;
              description
                "AP name or AP MAC address";
              leaf ap-name {
                type string;
                mandatory true;
                description
                  "Name of AP to configure the antenna band mode";
              }
              leaf mac-addr {
                type yang:mac-address;
                mandatory true;
                description
                  "MAC address of AP to configure the antenna band mode";
              }
            }  // choice alternative-choice
          }
        }  // rpc set-ap-antenna-band-mode
    
        rpc set-ap-country {
          description
            "Configure the country of operation";
          input {
            leaf country-string {
              type string {
                length "1..4";
                pattern '[ -~]+';
              }
              mandatory true;
              description
                "Country code for country of operation (i.e. US for United States)";
            }
    
            choice alternative-choice {
              mandatory true;
              description
                "Alternative AP name and MAC address";
              leaf ap-name {
                type string;
                mandatory true;
                description
                  "AP name for configuring country of operation";
              }
              leaf mac-addr {
                type yang:mac-address;
                mandatory true;
                description
                  "MAC address of AP for configuring country of operation";
              }
            }  // choice alternative-choice
          }
        }  // rpc set-ap-country
    
        rpc set-ap-slot-ext-antenna-gain {
          description
            "Configures the external antenna gain of AP";
          input {
            leaf external-antenna-gain {
              type uint8;
              units "dBm";
              mandatory true;
              description
                "External antenna gain value in multiple of .5 decibel isotropic units (i.e. An integer value 4 means 4 x 0.5 = 2 decibel isotropic units of gain)";
            }
    
            leaf slot-id {
              type uint8 {
                range "0..3";
              }
              mandatory true;
              description
                "Slot ID of AP to configure the external antenna gain. Valid value range is 0-3";
            }
    
            leaf band {
              when "(current()/../slot-id = 3)";
              type wireless-enum-types:enm-radio-band;
              default "band-6-ghz";
              description
                "Radio frequency band to configure external antenna gain.
    1 - 2.4 GHz
    2 - 5 GHz
    3 - Dual band
    4 - 6 Ghz";
            }
    
            choice alternative-choice {
              mandatory true;
              description
                "AP name or AP MAC address";
              leaf ap-name {
                type string;
                mandatory true;
                description
                  "Name of AP to configure the external antenna gain";
              }
              leaf mac-addr {
                type yang:mac-address;
                mandatory true;
                description
                  "MAC address of AP to configure the external antenna gain";
              }
            }  // choice alternative-choice
          }
        }  // rpc set-ap-slot-ext-antenna-gain
    
        rpc set-ap-slot-phy-ht-chan {
          description
            "Configures static channel on a radio interface of access point";
          input {
            leaf chan {
              type uint8;
              mandatory true;
              description
                "Specifies channel number";
            }
    
            leaf slot-id {
              type uint8 {
                range "0..2";
              }
              mandatory true;
              description
                "Specifies slot id of a radio band";
            }
    
            leaf band {
              type wireless-enum-types:enm-radio-band;
              must
                "current() != 'band-dualband-radio'" {
                error-message
                  "Dual band is not supported for this action";
                error-app-tag "must-violation";
              }
              mandatory true;
              description
                "Specifies radio band information of access point";
            }
    
            choice alternative-choice {
              mandatory true;
              description
                "AP name or AP MAC address";
              leaf ap-name {
                type string;
                mandatory true;
                description
                  "Name of AP to configure static channel";
              }
              leaf mac-addr {
                type yang:mac-address;
                mandatory true;
                description
                  "Mac address of AP to configure static channel";
              }
            }  // choice alternative-choice
          }
        }  // rpc set-ap-slot-phy-ht-chan
    
        rpc set-ap-slot-phy-ht-customize {
          description
            "Enables auto channel selection for a radio band of AP";
          input {
            leaf slot-id {
              type uint8 {
                range "0..2";
              }
              mandatory true;
              description
                "Specifies slot id of a radio band";
            }
    
            leaf band {
              type wireless-enum-types:enm-radio-band;
              must
                "current() != 'band-dualband-radio'" {
                error-message
                  "Dual band is not supported for this action";
                error-app-tag "must-violation";
              }
              mandatory true;
              description
                "Specifies radio band information of access point";
            }
    
            choice alternative-choice {
              mandatory true;
              description
                "AP name or AP MAC address";
              leaf ap-name {
                type string;
                mandatory true;
                description
                  "Name of AP to configure auto channel selection";
              }
              leaf mac-addr {
                type yang:mac-address;
                mandatory true;
                description
                  "MAC address of AP to configure auto selection";
              }
            }  // choice alternative-choice
          }
        }  // rpc set-ap-slot-phy-ht-customize
    
        rpc set-ap-cleanair {
          description
            "Configures clean air functionality on radio band of access point";
          input {
            leaf mode {
              type boolean;
              mandatory true;
              description
                "Enables/Disables clear air functionality";
            }
    
            leaf slot-id {
              type uint8 {
                range "0..2";
              }
              mandatory true;
              description
                "Specifies slot id of a radio band";
            }
    
            choice alternative-choice {
              mandatory true;
              description
                "AP name or AP MAC address";
              leaf ap-name {
                type string;
                mandatory true;
                description
                  "Name of AP to configure clean air";
              }
              leaf mac-addr {
                type yang:mac-address;
                mandatory true;
                description
                  "MAC address of AP to configure clean air";
              }
            }  // choice alternative-choice
          }
        }  // rpc set-ap-cleanair
    
        rpc dual-band-radio-band {
          description
            "Configures the 802.11 dual-band radio's current band i.e 2.4GHz/5GHz";
          input {
            leaf slot-id {
              type uint8 {
                range "0..2";
              }
              mandatory true;
              description
                "Slot ID of AP to configure the 802.11 dual-band radio's current band. Valid value range is 0-2";
            }
    
            leaf band {
              type uint32 {
                range "1..3";
              }
              mandatory true;
              description
                "Current band of AP
    1 - 2.4 GHz
    2 - 5 GHz
    3 - Dual band";
            }
    
            leaf toband {
              type uint32 {
                range "1..2";
              }
              mandatory true;
              description
                "New band to switch AP to from current band
    1 - 2.4 GHz
    2 - 5 GHz";
            }
    
            choice alternative-choice {
              mandatory true;
              description
                "AP name or AP MAC address";
              leaf ap-name {
                type string;
                mandatory true;
                description
                  "Name of AP to configure the 802.11 dual-band radio's current band";
              }
              leaf mac-addr {
                type yang:mac-address;
                mandatory true;
                description
                  "MAC address of AP to configure the 802.11 dual-band radio's current band";
              }
            }  // choice alternative-choice
          }
        }  // rpc dual-band-radio-band
    
        rpc lan-port-config-enable {
          description
            "AP LAN port configuration";
          input {
            leaf port-id {
              type wireless-enum-types:enm-lan-port-id;
              mandatory true;
              description
                "LAN port identification number";
            }
    
            leaf mode {
              when
                "../port-config-type = 'set-port-mode'";
              type boolean;
              mandatory true;
              description
                "LAN port can be enabled (true) or disabled (false)";
            }
    
            leaf poe-enabled {
              when
                "../port-config-type = 'set-poe-state'";
              type boolean;
              mandatory true;
              description
                "PoE of the LAN port can be enabled (true) or disabled (false)";
            }
    
            leaf power-level-id {
              when
                "../port-config-type = 'set-power-level'";
              type uint8 {
                range "1..4";
              }
              mandatory true;
              description
                "Power level of the LAN port";
            }
    
            leaf port-config-type {
              type wireless-enum-types:enm-lan-port-config;
              mandatory true;
              description
                "Port parameter to configure";
            }
    
            choice alternative-choice {
              mandatory true;
              description
                "AP name or AP MAC address";
              leaf ap-name {
                type string;
                mandatory true;
                description
                  "Name of AP to configure AP LAN port";
              }
              leaf mac-addr {
                type yang:mac-address;
                mandatory true;
                description
                  "MAC address of AP to configure AP LAN port";
              }
            }  // choice alternative-choice
          }
        }  // rpc lan-port-config-enable
    
        rpc set-ap-controller {
          description
            "Configures controller information in access point";
          input {
            leaf mode {
              type wireless-enum-types:enm-controller-name-status;
              must
                "(current() = 'controller-name-disable') or (string-length(../controller-name) > 0) or (string-length(../ipaddr) > 0)" {
                error-message
                  "Either controller-name or ipaddr need to be configured";
                error-app-tag "must-violation";
              }
              mandatory true;
              description
                "Configures/clears controller information in AP";
            }
    
            leaf controller-name {
              type string {
                length "1..31";
                pattern '[a-zA-Z0-9_\-]*';
              }
              description
                "Specifies controller name";
            }
    
            leaf index {
              type wireless-enum-types:enm-controller-index;
              mandatory true;
              description
                "Specifies primary/secondary/tertiary configuration";
            }
    
            leaf ipaddr {
              type inet:ip-address;
              description
                "Specifies IP address of controller";
            }
    
            choice alternative-choice {
              mandatory true;
              description
                "AP name or AP MAC address";
              leaf ap-name {
                type string;
                mandatory true;
                description
                  "Name of AP to configure controller information ";
              }
              leaf mac-addr {
                type yang:mac-address;
                mandatory true;
                description
                  "MAC address of AP to configure controller information ";
              }
            }  // choice alternative-choice
          }
        }  // rpc set-ap-controller
    
        rpc set-ap-led-brightness-level {
          description
            "Configure the led brightness level";
          input {
            leaf led-brightness-level {
              type uint8;
              mandatory true;
              description
                "LED brightness level (1..8)";
            }
    
            choice alternative-choice {
              mandatory true;
              description
                "AP name or AP MAC address";
              leaf ap-name {
                type string;
                mandatory true;
                description
                  "Name of AP to configure the led brightness level";
              }
              leaf mac-addr {
                type yang:mac-address;
                mandatory true;
                description
                  "MAC address of AP to configure the led brightness level";
              }
            }  // choice alternative-choice
          }
        }  // rpc set-ap-led-brightness-level
    
        rpc set-ap-slot-tx-power-level {
          description
            "Modify slot transmit power level";
          input {
            leaf tx-power-level {
              type uint8 {
                range "1 .. 8";
              }
              units "dBm";
              mandatory true;
              description
                "Transmit power level (1..8)";
            }
    
            leaf slot-id {
              type uint8 {
                range "0..3";
              }
              mandatory true;
              description
                "Slot ID of AP to configure transmit power level. Valid value range is 0-3.";
            }
    
            leaf band {
              type uint32 {
                range "1..4";
              }
              mandatory true;
              description
                "Band of AP to configure transmit power level
    1 - 2.4 GHz
    2 - 5 GHz
    3 - Dual band
    4 - 6 GHz";
            }
    
            choice alternative-choice {
              mandatory true;
              description
                "Alternative choice AP name and MAC address";
              leaf ap-name {
                type string;
                mandatory true;
                description
                  "AP name for configuring transmit power level";
              }
              leaf mac-addr {
                type yang:mac-address;
                mandatory true;
                description
                  "MAC address of AP for configuring transmit power level";
              }
            }  // choice alternative-choice
          }
        }  // rpc set-ap-slot-tx-power-level
    
        rpc set-ap-slot-antenna-mode {
          description
            "Configures the 802.11a antenna mode";
          input {
            leaf antenna-mode {
              type wireless-enum-types:enm-antenna-mode;
              mandatory true;
              description
                "Supported antenna mode";
            }
    
            leaf slot-id {
              type uint8 {
                range "0..2";
              }
              mandatory true;
              description
                "Slot ID of AP to configure the antenna mode. Valid value range is 0-2";
            }
    
            choice alternative-choice {
              mandatory true;
              description
                "AP name or AP MAC address";
              leaf ap-name {
                type string;
                mandatory true;
                description
                  "Name of AP to configure the antenna mode";
              }
              leaf mac-addr {
                type yang:mac-address;
                mandatory true;
                description
                  "MAC address of AP to configure the antenna mode";
              }
            }  // choice alternative-choice
          }
        }  // rpc set-ap-slot-antenna-mode
    
        rpc set-ap-admin-state {
          description
            "Enable/Disable AP admin state";
          input {
            leaf mode {
              type wireless-enum-types:enm-admin-status;
              mandatory true;
              description
                "Mode for AP admin state";
            }
    
            choice alternative-choice {
              mandatory true;
              description
                "AP name or AP MAC address";
              leaf ap-name {
                type string;
                mandatory true;
                description
                  "AP name for changing AP admin state";
              }
              leaf mac-addr {
                type yang:mac-address;
                mandatory true;
                description
                  "MAC address of AP for changing AP admin state";
              }
            }  // choice alternative-choice
          }
        }  // rpc set-ap-admin-state
    
        rpc set-ap-slot-admin-state {
          description
            "Configure slot admin state";
          input {
            leaf mode {
              type wireless-enum-types:enm-admin-status;
              mandatory true;
              description
                "Mode of AP to configure admin state";
            }
    
            leaf slot-id {
              type uint8 {
                range "0..3";
              }
              mandatory true;
              description
                "Slot ID of AP to configure admin state. Valid value range is 0-3.";
            }
    
            leaf band {
              type uint32 {
                range "1..3";
              }
              mandatory true;
              description
                "Radio frequency band of AP to configure admin state.
     1 - 2.4 GHz
     2 - 5 GHz
     3 - Dual band";
            }
    
            choice alternative-choice {
              mandatory true;
              description
                "AP name or AP MAC address";
              leaf ap-name {
                type string;
                mandatory true;
                description
                  "Name of AP to configure admin state";
              }
              leaf mac-addr {
                type yang:mac-address;
                mandatory true;
                description
                  "MAC address of AP to configure admin state";
              }
            }  // choice alternative-choice
          }
        }  // rpc set-ap-slot-admin-state
    
        rpc set-ap-slot-tx-power-customize {
          description "Enable auto RF on a slot";
          input {
            leaf mode {
              type wireless-types:w-config-type;
              mandatory true;
              description
                "Select mode as CONFIG AUTO to configure transmit power of AP";
            }
    
            leaf slot-id {
              type uint8 {
                range "0..3";
              }
              mandatory true;
              description
                "Slot ID of AP radio on which to configure transmit power. Valid value range is 0-3.";
            }
    
            leaf band {
              type uint32;
              mandatory true;
              description
                "Radio frequency band to configure transmit power on.
     1 - 2.4 GHz
     2 - 5 GHz
     3 - Dual band
     4 - 6 Ghz";
            }
    
            choice alternative-choice {
              mandatory true;
              description
                "AP name or AP MAC address";
              leaf ap-name {
                type string;
                mandatory true;
                description
                  "Name of AP to configure transmit power of AP";
              }
              leaf mac-addr {
                type yang:mac-address;
                mandatory true;
                description
                  "MAC address of AP to configure transmit power of AP";
              }
            }  // choice alternative-choice
          }
        }  // rpc set-ap-slot-tx-power-customize
      }  // module Cisco-IOS-XE-wireless-access-point-cfg-rpc
    

© 2023 YumaWorks, Inc. All rights reserved.