Change a Preshared Key

This procedure outlines how to update the WPA preshared key privacy for a networks service.

Note

The attributes in this topic are a representative sample of what is a available. For a complete list of attributes, elements, and resources, see the main documentation of the REST API. The documentation resides in a user interface that is accessed using this URL: http://api.extremenetworks.com/extremecloud/rest_api/index.html

To change a preshared key:

Log in to the REST API server (api.ezcloudx.com) using administrator credentials. You must also forward the credentials with each API call. For an example of how to log in, see Log in to the REST API Server.
Get the list of services to get the service ID you want to change:
```
GET HTTP://ipAddressmanagement/v1/services
```

Change the configuration using the PUT method:

PUT HTTP://ipAddress/management/v1/services/serviceId

When you POST or PUT data to the REST API, at minimum set the Content-Type header to application/json. However, you should generally specify two headers when you post the log in request.

Example:

content-type: application/json ;charset=UTF-8

accept: application/json, text/plain, */*

Any of the following Accept headers are allowed with the Content-Type header request header:

accept: application/json
accept-encoding: gzip, deflate, br
accept-language: en-US,en;q=0.8,und;q=0.6

Request Attributes: WpaPskElement

Attribute	Data Type	Description
isKeyHexEncoded	boolean	Indicates whether the shared key is a plain text string or an ASCII-encoded hex string which could include hex representations of binary data.
mode	WpaV2Mode	Whether to support legacy clients that only can use TKIP. Auto - means use AES when possible but use TKIP for clients that only speak TKIP. AES means only use AES encryption, even if it means that a TKIP only client cannot access the network. Default is "auto" but "aes" is more secure.
pmfMode	PmfMode	Whether to encrypt a subset of management frame traffic as specified by 802.11w. Default: enable
presharedKey	string	The shared key used by all APs and all clients accessing a service that is protected with the settings of this WpaPsk object. The length must be between 8 and 64 characters inclusive. Valid character set: Alphanumeric and special characters.

Example: PUT Request

{"custId":"MspEndCustomer-tenantid-zFj0XX0xXXxxX0xx",
"id":"0xx00000-00xx-00x0-xx00xx25-x00xxx00xxxx",
"serviceName":"Staff",
"status":"enabled",
"ssid":"Staff",
"defaultTopology":"00x0x00x-0xxx-00x0-0000-xxxx000xxx0x",
"defaultCoS":null,
"flexibleClientAccess":false,
"privacy":{"WpaPskElement":{"custId":null,
	"id":null,
	"mode":"auto",
	"pmfMode":"enabled",
	"inputType":"ASCII",
	"presharedKey":"abcd1234",
	"enableTkip":false,"keyHexEncoded":false}},
"privacyWpaPassPhrase":null,
"enabledSchedule":null,
"suppressSsid":false,
"mgmtFrameProtection":"enabled",
"enabled11kSupport":false,
"preAuthenticatedIdleTimeout":300,
"postAuthenticatedIdleTimeout":1800,
"sessionTimeout":0,
"uapsdEnabled":false,
"rm11ksupport":false,
"rm11kBeaconReport":false,
"rm11kQuietIe":false,
"admissionControlVideo":false,
"admissionControlVoice":false,
"admissionControlBestEffort":false,
"admissionControlBackgroundTraffic":false,
"airtimeFairness":false,
"mbaAuthorization":false,
"vendorSpecificAttributes":[],
"mbatimeoutRoleId":null,
"enableCaptivePortal":false,
"unAuthenticatedUserDefaultRoleID":"00x00xx0-0xxx-00x0-0000-xxxx000xxx0x",
"authenticatedUserDefaultRoleID":"00x00xx0-0xxx-00x0-0000-xxxx000xxx0x",
"features":["APP-CONTROL","CP-AT-AP","CP-AT-AP-PRONTO","IPV6","WIRED-PORTS"],
"captivePortalId":null,
"rejectOnRadiusTimeout":true,
"policyOnRadiusTimeout":null,
"tag":null,"aaaPolicy":null,
"azaraCos":null,
"bridgingMode":"local",
"roamingAssistPolicy":false,
"clientToClientCommunication":false,
"openDNSDeviceId":null,
"clientLoadBalancing":false,
"classification":"wmm",
"captivePortalType":"CPTYPE_NONE",
"redirectOrigDestOnSuccess":true,
"redirectHTTPS":false}

Example: Response

{"custId":"MspEndCustomer-tenantid-zFj0XX0xXXxxX0xx",
"id":"0xx00000-00xx-00x0-xx00xx25-x00xxx00xxxx",
"serviceName":"Staff",
"status":"enabled",
"ssid":"Staff",
"defaultTopology":"00x0x00x-0xxx-00x0-0000-xxxx000xxx0x",
"defaultCoS":null,
"flexibleClientAccess":false,
"privacy":{"WpaPskElement":{"custId":null,
	"id":null,
	"mode":"auto",
	"pmfMode":"enabled",
	"inputType":"ASCII",
	"presharedKey":"abcd1234",
	"enableTkip":false,"keyHexEncoded":false}},
"privacyWpaPassPhrase":null,
"enabledSchedule":null,
"suppressSsid":false,
"mgmtFrameProtection":"enabled",
"enabled11kSupport":false,
"preAuthenticatedIdleTimeout":300,
"postAuthenticatedIdleTimeout":1800,
"sessionTimeout":0,
"uapsdEnabled":false,
"rm11ksupport":false,
"rm11kBeaconReport":false,
"rm11kQuietIe":false,
"admissionControlVideo":false,
"admissionControlVoice":false,
"admissionControlBestEffort":false,
"admissionControlBackgroundTraffic":false,
"airtimeFairness":false,
"mbaAuthorization":false,
"vendorSpecificAttributes":[],
"mbatimeoutRoleId":null,
"enableCaptivePortal":false,
"unAuthenticatedUserDefaultRoleID":"00x00xx0-0xxx-00x0-0000-xxxx000xxx0x",
"authenticatedUserDefaultRoleID":"00x00xx0-0xxx-00x0-0000-xxxx000xxx0x",
"features":["APP-CONTROL","CP-AT-AP","CP-AT-AP-PRONTO","IPV6","WIRED-PORTS"],
"captivePortalId":null,
"rejectOnRadiusTimeout":true,
"policyOnRadiusTimeout":null,
"tag":null,"aaaPolicy":null,
"azaraCos":null,
"bridgingMode":"local",
"roamingAssistPolicy":false,
"clientToClientCommunication":false,
"openDNSDeviceId":null,
"clientLoadBalancing":false,
"classification":"wmm",
"captivePortalType":"CPTYPE_NONE",
"redirectOrigDestOnSuccess":true,
"redirectHTTPS":false}

Published September 2019prev | next

Email this topic

Print this page Print this page

Leave feedback Feedback