Represents a Wireless (WiFi) interface configured on a Network Service Gateway (NSG) instance. The WirelessPort instance may map to a physical WiFi card or a WiFi port.
This object has no members.
ID of the Egress QoS Policy associated with this Wireless Port.
Format: free
SDK attribute: associatedEgressQOSPolicyID
The frequency width of the selected channel for an instance of a Wireless Port. Generally, the default width is 20 MHz, but based on the WiFi mode and the frequency band, this could be changed to 40 or 80 MHz.
Allowed values: WIDTH_20_MHZ, WIDTH_80_MHZ, WIDTH_LESS_40_MHZ, WIDTH_PLUS_40_MHZ
Default value: WIDTH_20_MHZ
SDK attribute: channelWidth
Country code where the NSG with a Wireless Port installed is defined. The country code allows some WiFi features to be enabled or disabled on the Wireless card.
Allowed values: AD, AE, AF, AG, AI, AL, AM, AN, AO, AQ, AR, AS, AT, AU, AW, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BM, BN, BO, BR, BS, BT, BV, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CS, CU, CV, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, EH, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, ID, IE, IL, IN, IO, IQ, IR, IS, IT, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, RE, RO, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, ST, SV, SY, SZ, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, UM, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, YE, YT, ZA, ZM, ZW
SDK attribute: countryCode
A customer friendly description to be given to the Wireless Port instance.
Format: free
Max length: 255
SDK attribute: description
Metadata objects associated with this entity. This will contain a list of Metadata objects if the API request is made using the special flag to enable the embedded Metadata feature. Only a maximum of Metadata objects is returned based on the value set in the system configuration.
SDK attribute: embeddedMetadata
Specify if scope of entity is Data center or Enterprise level
Allowed values: ENTERPRISE, GLOBAL
SDK attribute: entityScope
External object ID. Used for integration with third party systems
Format: free
SDK attribute: externalID
The selected wireless frequency and channel used by the wireless interface. Channels range is from 0 to 165 where 0 stands for Auto Channel Selection.
Allowed values: CH_0, CH_1, CH_10, CH_100, CH_104, CH_108, CH_11, CH_112, CH_116, CH_12, CH_120, CH_124, CH_128, CH_13, CH_132, CH_136, CH_14, CH_140, CH_144, CH_149, CH_153, CH_157, CH_161, CH_165, CH_2, CH_3, CH_36, CH_4, CH_40, CH_44, CH_48, CH_5, CH_52, CH_56, CH_6, CH_60, CH_64, CH_7, CH_8, CH_9
Default value: CH_0
SDK attribute: frequencyChannel
This field is used to contain the 'blob' parameters for the WiFi Card (physical module) on the NSG.
Format: free
SDK attribute: genericConfig
ID of the user who last updated the object.
Format: free
SDK attribute: lastUpdatedBy
A customer friendly name for the Wireless Port instance.
Format: free
Min length: 1
Max length: 255
SDK attribute: name
The permitted action to USE/EXTEND this Wireless Port
Allowed values: ALL, DEPLOY, EXTEND, INSTANTIATE, READ, USE
SDK attribute: permittedAction
The identifier of the wireless port as identified by the OS running on the NSG. This name can't be modified once the port is created.
Allowed characters: Starts with 'wlan'
Format: free
Min length: 1
Max length: 255
SDK attribute: physicalName
Port type for the wireless port. This can be a port of type Access or Network.
Allowed values: ACCESS
Default value: ACCESS
SDK attribute: portType
Status of the Wireless Port. Possible values are - INITIALIZED, ORPHAN, READY, MISMATCH
Allowed values: INITIALIZED, MISMATCH, ORPHAN, READY
SDK attribute: status
User Mnemonic of the Port
Format: free
Max length: 255
SDK attribute: userMnemonic
Determines whether to use user mnemonic of the Wireless Port
SDK attribute: useUserMnemonic
VLAN Range of the Port. Format must conform to a-b,c,d-f where a,b,c,d,f are integers between 0 and 4095.
Format: free
Max length: 255
SDK attribute: VLANRange
Wireless frequency band set on the WiFi card installed. The standard currently supports two frequency bands, 5 GHz and 2.4 GHz. A future variant under name 802.11ad will support 60 GHz.
Allowed values: FREQ_2_4_GHZ, FREQ_5_0_GHZ
Default value: FREQ_2_4_GHZ
SDK attribute: wifiFrequencyBand
WirelessFidelity 802.11 norm used. The values supported represents a combination of modes that are to be enabled at once on the WiFi Card.
Allowed values: WIFI_A, WIFI_A_AC, WIFI_A_N, WIFI_A_N_AC, WIFI_B_G, WIFI_B_G_N
Default value: WIFI_B_G_N
SDK attribute: wifiMode