Share via

az sphere device wifi

  • Reference

Note

This reference is part of the azure-sphere extension for the Azure CLI (version 2.45.0 or higher). The extension will automatically install the first time you run an az sphere device wifi command. Learn more about extensions.

Manage Wi-Fi configurations for the attached device.

Commands

Name Description Type Status
az sphere device wifi add

Add a Wi-Fi network on the attached device.

 Extension GA
az sphere device wifi disable

Disable a Wi-Fi connection on the attached device.

 Extension GA
az sphere device wifi enable

Enable a Wi-Fi network on the attached device.

 Extension GA
az sphere device wifi forget

Forget a Wi-Fi network on the attached device.

 Extension GA
az sphere device wifi list

List the current Wi-Fi configurations for the attached device.

 Extension GA
az sphere device wifi reload-config

Reload the Wi-Fi network configuration on the attached device. Use this command after you add or remove a certificate (azsphere device certificate) to ensure that EAP-TLS networks use the most recent contents of the certificate store.

 Extension GA
az sphere device wifi scan

Scan for available Wi-Fi networks visible to the attached device.

 Extension GA
az sphere device wifi show

Show details of a Wi-Fi network on the attached device.

 Extension GA
az sphere device wifi show-status

Show the status of the wireless interface on the attached device.

 Extension GA

az sphere device wifi add

Add a Wi-Fi network on the attached device.

az sphere device wifi add --ssid
                          [--client-cert-id]
                          [--client-id]
                          [--config-name]
                          [--device]
                          [--psk]
                          [--root-ca-cert-id]
                          [--targeted-scan]

Examples

Add open Wi-Fi network

az sphere device wifi add --ssid

Add a WPA/WPA2 PSK-protected Wi-Fi network

az sphere device wifi add --ssid NETWORK1 --psk EXAMPLEPSK

Add an EAP-TLS Wi-Fi network

az sphere device wifi add --ssid myEapTlsSsid --client-cert-id myClientCert --client-id user@domain.com --root-ca-cert-id myRootCA --config-name Network1

Required Parameters

--ssid -s

The SSID of the network to connect to.

Optional Parameters

--client-cert-id

[EAP-TLS] - A string value (up to 16 characters) that identifies the client certificate (containing both the public and private key). Required to set up an EAP-TLS network.

--client-id

user@domain [EAP-TLS] ID recognized for authentication by this network's RADIUS server. Required for some EAP-TLS networks.

--config-name

A string value (up to 16 characters) that specifies the name for this network configuration.

--device -d

The device to run the command on when multiple devices are attached. Specify the ID, IP address, or Local Connection ID of an attached device.

Value from: az sphere device list-attached
--psk -p

The WPA/WPA2 PSK for the new network. Do not set this if connecting to an open network.

--root-ca-cert-id

[EAP-TLS] - A string value (up to 16 characters) that identifies the server's root CA certificate for EAP-TLS networks where the device authenticates the server.

--targeted-scan

Attempt to connect to an SSID even if not advertised.

Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az sphere device wifi disable

Disable a Wi-Fi connection on the attached device.

az sphere device wifi disable --id
                              [--device]

Examples

Disable configured Wi-Fi network

az sphere device wifi disable --id 1

Required Parameters

--id -i

The ID of the network to disable.

Optional Parameters

--device -d

The device to run the command on when multiple devices are attached. Specify the ID, IP address, or Local Connection ID of an attached device.

Value from: az sphere device list-attached
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az sphere device wifi enable

Enable a Wi-Fi network on the attached device.

az sphere device wifi enable --id
                             [--device]

Examples

Enable configured Wi-Fi network

az sphere device wifi enable --id 1

Required Parameters

--id -i

The ID of the network to enable.

Optional Parameters

--device -d

The device to run the command on when multiple devices are attached. Specify the ID, IP address, or Local Connection ID of an attached device.

Value from: az sphere device list-attached
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az sphere device wifi forget

Forget a Wi-Fi network on the attached device.

az sphere device wifi forget --id
                             [--device]

Examples

Forget configured Wi-Fi network

az sphere device wifi forget --id 1

Required Parameters

--id -i

The ID of the network to forget.

Optional Parameters

--device -d

The device to run the command on when multiple devices are attached. Specify the ID, IP address, or Local Connection ID of an attached device.

Value from: az sphere device list-attached
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az sphere device wifi list

List the current Wi-Fi configurations for the attached device.

az sphere device wifi list [--device]

Examples

List configured Wi-Fi network

az sphere device wifi list

Optional Parameters

--device -d

The device to run the command on when multiple devices are attached. Specify the ID, IP address, or Local Connection ID of an attached device.

Value from: az sphere device list-attached
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az sphere device wifi reload-config

Reload the Wi-Fi network configuration on the attached device. Use this command after you add or remove a certificate (azsphere device certificate) to ensure that EAP-TLS networks use the most recent contents of the certificate store.

az sphere device wifi reload-config [--device]

Examples

Reload configured Wi-Fi network

az sphere device wifi reload-config

Optional Parameters

--device -d

The device to run the command on when multiple devices are attached. Specify the ID, IP address, or Local Connection ID of an attached device.

Value from: az sphere device list-attached
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az sphere device wifi scan

Scan for available Wi-Fi networks visible to the attached device.

az sphere device wifi scan [--device]

Examples

Scan for Wi-Fi networks

az sphere device wifi scan

Optional Parameters

--device -d

The device to run the command on when multiple devices are attached. Specify the ID, IP address, or Local Connection ID of an attached device.

Value from: az sphere device list-attached
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az sphere device wifi show

Show details of a Wi-Fi network on the attached device.

az sphere device wifi show --id
                           [--device]

Examples

Show details of a configured Wi-Fi network

az sphere device wifi show

Required Parameters

--id -i

The ID of the network to show details for.

Optional Parameters

--device -d

The device to run the command on when multiple devices are attached. Specify the ID, IP address, or Local Connection ID of an attached device.

Value from: az sphere device list-attached
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az sphere device wifi show-status

Show the status of the wireless interface on the attached device.

az sphere device wifi show-status [--device]

Examples

Show status of configured Wi-Fi network

az sphere device wifi show-status

Optional Parameters

--device -d

The device to run the command on when multiple devices are attached. Specify the ID, IP address, or Local Connection ID of an attached device.

Value from: az sphere device list-attached
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.