WirelessPortTemplate

Template of a Wireless Interface that may exist on a NSGateway Template instance. Instantiation of NSG Template will result in the creation of a Wireless Port instance on the NSG instance. Parameters defined on the template will be used to polulate the attributes on the Wireless Port instance inheriting from the template.

Overview

countryCode enum (CA | FR | UK | US) required   filterable   orderable  
description string
frequencyChannel enum (CH_0 | CH_1 | CH_2) required   filterable   orderable  
genericConfig string
name string required   filterable   orderable  
physicalName string required   creation only   filterable   orderable   locally unique  
portType enum (ACCESS) required   filterable   orderable  
wifiFrequencyBand enum (FREQ_2_4_GHZ | FREQ_5_0_GHZ) required   filterable   orderable  
wifiMode enum (WIFI_A | WIFI_A_AC | WIFI_A_N | WIFI_A_N_AC | WIFI_B_G | WIFI_B_G_N) required   filterable   orderable  

API Resource

/wirelessporttemplates/id
delete get put

Parents

This object has no parents.

Children

This object has no children.

Members

This object has no members.

Attributes documentation

countryCode enum required   filterable   orderable  
Discussion

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.

Charateristics

Allowed values: CA, FR, UK, US
SDK attribute: countryCode

description string
Discussion

A customer friendly description to be given to the Wireless Port Template.

Charateristics

Format: free
Max length: 255
SDK attribute: description

frequencyChannel enum required   filterable   orderable  
Discussion

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.

Charateristics

Allowed values: CH_0, CH_1, CH_2
Default value: CH_0
SDK attribute: frequencyChannel

genericConfig string
Discussion

Configuration blob for the Wireless Port/Card installed on the NSG. It contains the less common Wireless parameters that can be configured at the OS level for the WiFi card.

Charateristics

Format: free
Max length: 4096
SDK attribute: genericConfig

name string required   filterable   orderable  
Discussion

A customer friendly name for the Wireless Port template.

Charateristics

Format: free
Min length: 1
Max length: 255
SDK attribute: name

physicalName string required   creation only   filterable   orderable   locally unique  
Discussion

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.

Charateristics

Format: free
Min length: 1
Max length: 255
SDK attribute: physicalName

portType enum required   filterable   orderable  
Discussion

Port type for the wireless port. This can be a port of type Access or Network.

Charateristics

Allowed values: ACCESS
Default value: ACCESS
SDK attribute: portType

wifiFrequencyBand enum required   filterable   orderable  
Discussion

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.

Charateristics

Allowed values: FREQ_2_4_GHZ, FREQ_5_0_GHZ
Default value: FREQ_2_4_GHZ
SDK attribute: wifiFrequencyBand

wifiMode enum required   filterable   orderable  
Discussion

WirelessFidelity 802.11 norm used. The values supported represents a combination of modes that are to be enabled at once on the WiFi Card.

Charateristics

Allowed values: WIFI_A, WIFI_A_AC, WIFI_A_N, WIFI_A_N_AC, WIFI_B_G, WIFI_B_G_N
Default value: WIFI_A_N_AC
SDK attribute: wifiMode