az mobile-network pccp

  • Reference

Note

This reference is part of the mobile-network extension for the Azure CLI (version 2.55.0 or higher). The extension will automatically install the first time you run an az mobile-network pccp command. Learn more about extensions.

Manage packet core control plane.

Commands

Name Description Type Status
az mobile-network pccp collect-diagnostics-package

Collect a diagnostics package for the specified packet core control plane. This action will upload the diagnostics to a storage account.

 Extension GA
az mobile-network pccp create

Create a packet core control plane.

 Extension GA
az mobile-network pccp delete

Delete the specified packet core control plane.

 Extension GA
az mobile-network pccp list

List all the packet core control planes in a subscription.

 Extension GA
az mobile-network pccp reinstall

Reinstall the specified packet core control plane. This action will remove any transaction state from the packet core to return it to a known state. This action will cause a service outage.

 Extension GA
az mobile-network pccp rollback

Roll back the specified packet core control plane to the previous version, "rollbackVersion". Multiple consecutive rollbacks are not possible. This action may cause a service outage.

 Extension GA
az mobile-network pccp show

Get information about the specified packet core control plane.

 Extension GA
az mobile-network pccp update

Update a packet core control plane.

 Extension GA
az mobile-network pccp version

Manage packet core control plane version.

 Extension GA
az mobile-network pccp version list

List all supported packet core control planes versions.

 Extension GA
az mobile-network pccp version show

Get information about the specified packet core control plane version.

 Extension GA
az mobile-network pccp wait

Place the CLI in a waiting state until a condition is met.

 Extension GA

az mobile-network pccp collect-diagnostics-package

Collect a diagnostics package for the specified packet core control plane. This action will upload the diagnostics to a storage account.

az mobile-network pccp collect-diagnostics-package --blob-url
                                                   [--ids]
                                                   [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                   [--pccp-name]
                                                   [--resource-group]
                                                   [--subscription]

Examples

Collect diagnostics package

az mobile-network pccp collect-diagnostics-package --pccp-name pccp -g rg --blob-url https://contosoaccount.blob.core.windows.net/container/diagnosticsPackage.zip

Required Parameters

--blob-url

The Storage Account Blob URL to upload the diagnostics package to.

Optional Parameters

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--no-wait

Do not wait for the long-running operation to finish.

accepted values: 0, 1, f, false, n, no, t, true, y, yes
--pccp-name

The name of the packet core control plane.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

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

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 mobile-network pccp create

Create a packet core control plane.

az mobile-network pccp create --access-interface
                              --local-diagnostics
                              --name
                              --platform
                              --resource-group
                              --sites
                              --sku {G0, G1, G10, G2, G5}
                              [--core-network-tec {5GC, EPC, EPC + 5GC}]
                              [--identity]
                              [--location]
                              [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                              [--tags]
                              [--ue-mtu]
                              [--version]

Examples

Create Packet Core Control Plane

az mobile-network pccp create -n pccp-name -g rg --access-interface "{name:N2,ipv4Address:10.28.128.2,ipv4Subnet:10.28.128.0/24,ipv4Gateway:10.28.128.1}" --local-diagnostics "{authentication-type:AAD}" --platform "{type:AKS-HCI}" --sites "[{id:site-id}]" --sku G0

Required Parameters

--access-interface

The control plane interface on the access network. For 5G networks, this is the N2 interface. For 4G networks, this is the S1-MME interface. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--local-diagnostics

The kubernetes ingress configuration to control access to packet core diagnostics over local APIs. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--name --pccp-name -n

The name of the packet core control plane.

--platform

The platform where the packet core is deployed. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--sites

Site(s) under which this packet core control plane should be deployed. The sites must be in the same location as the packet core control plane. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--sku

The SKU defining the throughput and SIM allowances for this packet core control plane deployment.

accepted values: G0, G1, G10, G2, G5

Optional Parameters

--core-network-tec

The core network technology generation (5G core or EPC / 4G core).

accepted values: 5GC, EPC, EPC + 5GC
default value: 5GC
--identity

The identity used to retrieve the ingress certificate from Azure key vault. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--location -l

The geo-location where the resource lives When not specified, the location of the resource group will be used.

--no-wait

Do not wait for the long-running operation to finish.

accepted values: 0, 1, f, false, n, no, t, true, y, yes
--tags

Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--ue-mtu

The MTU (in bytes) signaled to the UE. The same MTU is set on the user plane data links for all data networks. The MTU set on the user plane access link is calculated to be 60 bytes greater than this value to allow for GTP encapsulation.

default value: 1440
--version

The version of the packet core software that is deployed.

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 mobile-network pccp delete

Delete the specified packet core control plane.

az mobile-network pccp delete [--ids]
                              [--name]
                              [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                              [--resource-group]
                              [--subscription]
                              [--yes]

Examples

Delete Packet Core Control Plane

az mobile-network pccp delete -n pccp-name -g rg -y

Optional Parameters

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--name --pccp-name -n

The name of the packet core control plane.

--no-wait

Do not wait for the long-running operation to finish.

accepted values: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

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

--yes -y

Do not prompt for confirmation.

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 mobile-network pccp list

List all the packet core control planes in a subscription.

az mobile-network pccp list [--max-items]
                            [--next-token]
                            [--resource-group]

Examples

List Packet Core Control Plane by resource group

az mobile-network pccp list -g rg

Optional Parameters

--max-items

Total number of items to return in the command's output. If the total number of items available is more than the value specified, a token is provided in the command's output. To resume pagination, provide the token value in --next-token argument of a subsequent command.

--next-token

Token to specify where to start paginating. This is the token value from a previously truncated response.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

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 mobile-network pccp reinstall

Reinstall the specified packet core control plane. This action will remove any transaction state from the packet core to return it to a known state. This action will cause a service outage.

az mobile-network pccp reinstall [--ids]
                                 [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                 [--pccp-name]
                                 [--resource-group]
                                 [--subscription]

Examples

Reinstall Packet Core Control Plane

az mobile-network pccp reinstall --pccp-name pccp-name -g rg

Optional Parameters

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--no-wait

Do not wait for the long-running operation to finish.

accepted values: 0, 1, f, false, n, no, t, true, y, yes
--pccp-name

The name of the packet core control plane.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

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

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 mobile-network pccp rollback

Roll back the specified packet core control plane to the previous version, "rollbackVersion". Multiple consecutive rollbacks are not possible. This action may cause a service outage.

az mobile-network pccp rollback [--ids]
                                [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                [--pccp-name]
                                [--resource-group]
                                [--subscription]

Examples

Rollback Packet Core Control Plane

az mobile-network pccp rollback --pccp-name pccp-name -g rg

Optional Parameters

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--no-wait

Do not wait for the long-running operation to finish.

accepted values: 0, 1, f, false, n, no, t, true, y, yes
--pccp-name

The name of the packet core control plane.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

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

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 mobile-network pccp show

Get information about the specified packet core control plane.

az mobile-network pccp show [--ids]
                            [--name]
                            [--resource-group]
                            [--subscription]

Examples

Show Packet Core Control Plane

az mobile-network pccp show -n pccp-name -g rg

Optional Parameters

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--name --pccp-name -n

The name of the packet core control plane.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

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

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 mobile-network pccp update

Update a packet core control plane.

az mobile-network pccp update [--access-interface]
                              [--add]
                              [--core-network-tec {5GC, EPC, EPC + 5GC}]
                              [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                              [--identity]
                              [--ids]
                              [--local-diagnostics]
                              [--name]
                              [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                              [--platform]
                              [--remove]
                              [--resource-group]
                              [--set]
                              [--sites]
                              [--sku {G0, G1, G10, G2, G5}]
                              [--subscription]
                              [--tags]
                              [--ue-mtu]
                              [--version]

Examples

Update Packet Core Control Plane tags

az mobile-network pccp update -n pccp-name -g rg --ue-mtu 1500 --tags "{tag:test,tag2:test2}"

Optional Parameters

--access-interface

The control plane interface on the access network. For 5G networks, this is the N2 interface. For 4G networks, this is the S1-MME interface. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--add

Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty <key=value, string or JSON string>.

--core-network-tec

The core network technology generation (5G core or EPC / 4G core).

accepted values: 5GC, EPC, EPC + 5GC
--force-string

When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.

accepted values: 0, 1, f, false, n, no, t, true, y, yes
--identity

The identity used to retrieve the ingress certificate from Azure key vault. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--local-diagnostics

The kubernetes ingress configuration to control access to packet core diagnostics over local APIs. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--name --pccp-name -n

The name of the packet core control plane.

--no-wait

Do not wait for the long-running operation to finish.

accepted values: 0, 1, f, false, n, no, t, true, y, yes
--platform

The platform where the packet core is deployed. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--remove

Remove a property or an element from a list. Example: --remove property.list OR --remove propertyToRemove.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--set

Update an object by specifying a property path and value to set. Example: --set property1.property2=.

--sites

Site(s) under which this packet core control plane should be deployed. The sites must be in the same location as the packet core control plane. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--sku

The SKU defining the throughput and SIM allowances for this packet core control plane deployment.

accepted values: G0, G1, G10, G2, G5
--subscription

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

--tags

Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--ue-mtu

The MTU (in bytes) signaled to the UE. The same MTU is set on the user plane data links for all data networks. The MTU set on the user plane access link is calculated to be 60 bytes greater than this value to allow for GTP encapsulation.

--version

The version of the packet core software that is deployed.

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 mobile-network pccp wait

Place the CLI in a waiting state until a condition is met.

az mobile-network pccp wait [--created]
                            [--custom]
                            [--deleted]
                            [--exists]
                            [--ids]
                            [--interval]
                            [--name]
                            [--resource-group]
                            [--subscription]
                            [--timeout]
                            [--updated]

Optional Parameters

--created

Wait until created with 'provisioningState' at 'Succeeded'.

default value: False
--custom

Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Wait until deleted.

default value: False
--exists

Wait until the resource exists.

default value: False
--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--interval

Polling interval in seconds.

default value: 30
--name --pccp-name -n

The name of the packet core control plane.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

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

--timeout

Maximum wait in seconds.

default value: 3600
--updated

Wait until updated with provisioningState at 'Succeeded'.

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.