# Web Cloud › Internet › Access › Modem › Templates API

> Part of the OVHcloud developer hub. Index of every page and section: https://developers.eu.ovhcloud.com/llms.txt
> The Web Cloud product's sections: https://developers.eu.ovhcloud.com/reference/web-cloud/llms.txt
> Everything in one file: https://developers.eu.ovhcloud.com/llms-full.txt

> 5 operations of the OVHcloud API. Calls carry `authorization: Bearer $OVH_TOKEN`; the EU host is shown, Canada and the United States answer on api.ca.ovhcloud.com and api.us.ovhcloud.com.

Page: https://developers.eu.ovhcloud.com/reference/web-cloud/internet/access/modem/templates/

OpenAPI v1: https://api.eu.ovhcloud.com/1.0/__schemas/developer-hub-navigation/web-cloud/internet/access/modem/templates.json?format=openapi3
OpenAPI v2: https://api.eu.ovhcloud.com/v2/__schemas/developer-hub-navigation/web-cloud/internet/access/modem/templates.json?format=openapi3

## Operations

- `GET /xdsl/templateModem` — List modem templates
- `POST /xdsl/templateModem` — Create a modem template
- `GET /xdsl/templateModem/{name}` — Get a modem template
- `PUT /xdsl/templateModem/{name}` — Update a modem template
- `DELETE /xdsl/templateModem/{name}` — Delete a modem template

## List modem templates

`GET /1.0/xdsl/templateModem`

Link: https://developers.eu.ovhcloud.com/reference/web-cloud/internet/access/modem/templates/#getModemTemplates

**Status:** Stable production version  
**IAM actions:** `account:apiovh:xdslTemplateModem/get`

Returns the names of the modem templates of the account.

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | string[] | successful operation |

```json
[
  "string"
]
```

### Example

```bash
curl -X GET \
  "https://api.eu.ovhcloud.com/1.0/xdsl/templateModem" \
  -H "accept: application/json" \
  -H "authorization: Bearer $OVH_TOKEN"
```

```python
'''
First, install the latest release of Python wrapper: $ pip install ovh
'''
import json
import ovh

# Instantiate an OVH Client.
# You can generate new credentials with full access to your account on
# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
client = ovh.Client(
	endpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
	application_key='xxxxxxxxxx',    # Application Key
	application_secret='xxxxxxxxxx', # Application Secret
	consumer_key='xxxxxxxxxx',       # Consumer Key
)

result = client.get("/xdsl/templateModem")

# Pretty print
print(json.dumps(result, indent=4))
```

```php
<?php
/**
 * First, download the latest release of PHP wrapper on github
 * And include this script into the folder with extracted files
 */
require __DIR__ . '/vendor/autoload.php';
use \Ovh\Api;

/**
 * Instantiate an OVH Client.
 * You can generate new credentials with full access to your account on
 * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
 */
$ovh = new Api('xxxxxxxxxx',  // Application Key
               'xxxxxxxxxx',  // Application Secret
               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
               'xxxxxxxxxx'); // Consumer Key

$result = $ovh->get("/xdsl/templateModem");

print_r($result);
?>
```

## Create a modem template

`POST /1.0/xdsl/templateModem`

Link: https://developers.eu.ovhcloud.com/reference/web-cloud/internet/access/modem/templates/#createModemTemplate

**Status:** Stable production version  
**IAM actions:** `account:apiovh:xdslTemplateModem/create`

Creates a template from the modem configuration of an access. Returns the created template.

### Request body (required)

Type: `xdsl.templateModem.post`

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `name` | string | yes | Modem Template name (only alphanumeric characters) |
| `serviceName` | string | yes | The access name with the config you want to duplicate |

```json
{
  "name": "string",
  "serviceName": "string"
}
```

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | xdsl.TemplateModem | successful operation |

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `DHCP` | xdsl.templateModem.DHCP[] | read-only | List of DHCP for this template |
| `DHCP[].defaultGateway` | ip | read-only | IP address (e.g., 192.0.2.0) |
| `DHCP[].dhcpName` | string | read-only | Name of the DHCP |
| `DHCP[].domainName` | string | read-only | Domain name provided to the clients |
| `DHCP[].endAddress` | ip | read-only | IP address (e.g., 192.0.2.0) |
| `DHCP[].leaseTime` | integer | read-only | Lease time in seconds of client assigned address (-1 means infinite) |
| `DHCP[].primaryDNS` | ip | read-only | IP address (e.g., 192.0.2.0) |
| `DHCP[].secondaryDNS` | ip | read-only | Secondary DNS servers to be given to the clients |
| `DHCP[].serverEnabled` | boolean | read-only | State of the DHCP server of the modem |
| `DHCP[].startAddress` | ip | read-only | IP address (e.g., 192.0.2.0) |
| `DHCP[].subnetMask` | ip | read-only | IP address (e.g., 192.0.2.0) |
| `LAN` | xdsl.templateModem.LAN[] | read-only | List of LAN for this template |
| `LAN[].IPAddress` | ip | read-only | IP address (e.g., 192.0.2.0) |
| `LAN[].addressingType` | xdsl.xdslModemConfig.AddressingTypeEnum | read-only | How the modem gets its LAN IP Address — one of `DHCP`, `Static` |
| `LAN[].lanName` | string | read-only | Name of the LAN |
| `LAN[].subnetMask` | ip | read-only | IP address (e.g., 192.0.2.0) |
| `WLAN` | xdsl.templateModem.WLAN[] | read-only | List of WLAN for this template |
| `WLAN[].SSID` | string | read-only | Service Set Identifier of the WLAN interface |
| `WLAN[].SSIDAdvertisementEnabled` | boolean | read-only | Control if Wifi is discoverable or hidden |
| `WLAN[].bandSteering` | boolean | read-only | Indicate if frequencies 2.4GHz and 5GHz are agregated |
| `WLAN[].channel` | integer | read-only | Channel number (Useless if channelMode is set to Auto) |
| `WLAN[].channelMode` | xdsl.xdslModemConfig.ChannelModeEnum | read-only | How the WiFi channel is selected — one of `Auto`, `Manual` |
| `WLAN[].enabled` | boolean | read-only | Wifi state |
| `WLAN[].frequency` | xdsl.xdslModemConfig.FrequencyEnum | read-only | Modem frequency — one of `2.4GHz`, `5GHz` |
| `WLAN[].guest` | boolean | read-only | Indicate if it is normal access wifi or guest wifi |
| `WLAN[].securityKey` | string (password) | read-only | Encrypted WLAN passphrase |
| `WLAN[].securityType` | xdsl.templateModem.SecurityTypeEnum | read-only | Type of WLAN security protection — one of `None`, `WPA`, `WPA2`, `WPA2andWPA3`, `WPA3`, `WPAandWPA2` |
| `WLAN[].wifiName` | string | read-only | Wifi Name |
| `capabilities` | string | read-only | Parameters capabilities. Lists what can be applied from this template |
| `creationDate` | string (date-time) | read-only | Template creation date |
| `dmzIP` | ip | read-only | IP Address of the DMZ |
| `mtuSize` | xdsl.xdslModemConfig.MTUSizeEnum | read-only | Size of the Maximum Transmission Unit on the modem's interfaces — one of `1432`, `1456`, `1492` |
| `name` | string | read-only | Name of the Modem Template |
| `parametersToIgnore` | xdsl.templateModem.ParametersToIgnore |  | Do not apply these parameters from template. You can use parametersCapabilities to know availability |
| `parametersToIgnore.LANandDHCP` | boolean |  | Ignore LAN and DHCP configurations |
| `parametersToIgnore.WLANList` | string[] |  | WLAN names list to ignore. Ignore only listed WLAN |
| `parametersToIgnore.dmzIP` | boolean |  | Ignore DMZ configuration |
| `parametersToIgnore.mtuSize` | boolean |  | Ignore MTU Size value |
| `parametersToIgnore.portMappingList` | string[] |  | PortMapping names list to ignore. Ignore only listed portMapping |
| `portMapping` | xdsl.templateModem.PortMapping[] | read-only | List of PortMapping for this template |
| `portMapping[].allowedRemoteIp` | ipv4 | read-only | An ip which will access to the defined rule. Default : no restriction applied |
| `portMapping[].description` | string | read-only | Description of the Port Mapping |
| `portMapping[].externalPortEnd` | integer | read-only | The last port of the interval on the External Client that will get the connections |
| `portMapping[].externalPortStart` | integer | read-only | External Port that the modem will listen on. List of externalPorts not available for now in the API : 8, 21, 68, 5060, 21800-21805, 51005 |
| `portMapping[].internalClient` | ip | read-only | IP address (e.g., 192.0.2.0) |
| `portMapping[].internalPort` | integer | read-only | The port on the Internal Client that will get the connections |
| `portMapping[].name` | string | read-only | Name of the port mapping entry |
| `portMapping[].protocol` | xdsl.xdslModemConfig.ProtocolTypeEnum | read-only | Type of protocol for the Port Mapping — one of `TCP`, `UDP` |

```json
{
  "DHCP": [
    {
      "defaultGateway": "192.0.2.0",
      "dhcpName": "string",
      "domainName": "string",
      "endAddress": "192.0.2.0",
      "leaseTime": 0,
      "primaryDNS": "192.0.2.0",
      "secondaryDNS": "192.0.2.0",
      "serverEnabled": true,
      "startAddress": "192.0.2.0",
      "subnetMask": "192.0.2.0"
    }
  ],
  "LAN": [
    {
      "IPAddress": "192.0.2.0",
      "addressingType": "DHCP",
      "lanName": "string",
      "subnetMask": "192.0.2.0"
    }
  ],
  "WLAN": [
    {
      "SSID": "string",
      "SSIDAdvertisementEnabled": true,
      "bandSteering": true,
      "channel": 0,
      "channelMode": "Auto",
      "enabled": true,
      "frequency": "2.4GHz",
      "guest": true,
      "securityKey": "string",
      "securityType": "None",
      "wifiName": "string"
    }
  ],
  "capabilities": "string",
  "creationDate": "2024-01-01T12:00:00Z",
  "dmzIP": "192.0.2.0",
  "mtuSize": 1432,
  "name": "string",
  "parametersToIgnore": {
    "LANandDHCP": true,
    "WLANList": [
      "string"
    ],
    "dmzIP": true,
    "mtuSize": true,
    "portMappingList": [
      "string"
    ]
  },
  "portMapping": [
    {
      "allowedRemoteIp": "192.0.2.0",
      "description": "string",
      "externalPortEnd": 0,
      "externalPortStart": 0,
      "internalClient": "192.0.2.0",
      "internalPort": 0,
      "name": "string",
      "protocol": "TCP"
    }
  ]
}
```

### Example

```bash
curl -X POST \
  "https://api.eu.ovhcloud.com/1.0/xdsl/templateModem" \
  -H "accept: application/json" \
  -H "authorization: Bearer $OVH_TOKEN" \
  -H "content-type: application/json" \
  -d '{ }'
```

```python
'''
First, install the latest release of Python wrapper: $ pip install ovh
'''
import json
import ovh

# Instantiate an OVH Client.
# You can generate new credentials with full access to your account on
# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
client = ovh.Client(
	endpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
	application_key='xxxxxxxxxx',    # Application Key
	application_secret='xxxxxxxxxx', # Application Secret
	consumer_key='xxxxxxxxxx',       # Consumer Key
)

# Request body type: xdsl.templateModem.post
result = client.post("/xdsl/templateModem",
	name = None, # Modem Template name (only alphanumeric characters) (type: string)
	serviceName = None, # The access name with the config you want to duplicate (type: string)
)

# Pretty print
print(json.dumps(result, indent=4))
```

```php
<?php
/**
 * First, download the latest release of PHP wrapper on github
 * And include this script into the folder with extracted files
 */
require __DIR__ . '/vendor/autoload.php';
use \Ovh\Api;

/**
 * Instantiate an OVH Client.
 * You can generate new credentials with full access to your account on
 * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
 */
$ovh = new Api('xxxxxxxxxx',  // Application Key
               'xxxxxxxxxx',  // Application Secret
               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
               'xxxxxxxxxx'); // Consumer Key

// Request body type: xdsl.templateModem.post
$result = $ovh->post("/xdsl/templateModem", array(
	name => null, // Modem Template name (only alphanumeric characters) (type: string)
	serviceName => null, // The access name with the config you want to duplicate (type: string)
));

print_r($result);
?>
```

## Get a modem template

`GET /1.0/xdsl/templateModem/{name}`

Link: https://developers.eu.ovhcloud.com/reference/web-cloud/internet/access/modem/templates/#getModemTemplate

**Status:** Stable production version  
**IAM actions:** `account:apiovh:xdslTemplateModem/get`

Returns the LAN, DHCP, WLAN, port mapping, DMZ and MTU settings of a modem template, and the parameters to ignore when it is applied.

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `name` | path | string | yes | Name |

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | xdsl.TemplateModem | successful operation |

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `DHCP` | xdsl.templateModem.DHCP[] | read-only | List of DHCP for this template |
| `DHCP[].defaultGateway` | ip | read-only | IP address (e.g., 192.0.2.0) |
| `DHCP[].dhcpName` | string | read-only | Name of the DHCP |
| `DHCP[].domainName` | string | read-only | Domain name provided to the clients |
| `DHCP[].endAddress` | ip | read-only | IP address (e.g., 192.0.2.0) |
| `DHCP[].leaseTime` | integer | read-only | Lease time in seconds of client assigned address (-1 means infinite) |
| `DHCP[].primaryDNS` | ip | read-only | IP address (e.g., 192.0.2.0) |
| `DHCP[].secondaryDNS` | ip | read-only | Secondary DNS servers to be given to the clients |
| `DHCP[].serverEnabled` | boolean | read-only | State of the DHCP server of the modem |
| `DHCP[].startAddress` | ip | read-only | IP address (e.g., 192.0.2.0) |
| `DHCP[].subnetMask` | ip | read-only | IP address (e.g., 192.0.2.0) |
| `LAN` | xdsl.templateModem.LAN[] | read-only | List of LAN for this template |
| `LAN[].IPAddress` | ip | read-only | IP address (e.g., 192.0.2.0) |
| `LAN[].addressingType` | xdsl.xdslModemConfig.AddressingTypeEnum | read-only | How the modem gets its LAN IP Address — one of `DHCP`, `Static` |
| `LAN[].lanName` | string | read-only | Name of the LAN |
| `LAN[].subnetMask` | ip | read-only | IP address (e.g., 192.0.2.0) |
| `WLAN` | xdsl.templateModem.WLAN[] | read-only | List of WLAN for this template |
| `WLAN[].SSID` | string | read-only | Service Set Identifier of the WLAN interface |
| `WLAN[].SSIDAdvertisementEnabled` | boolean | read-only | Control if Wifi is discoverable or hidden |
| `WLAN[].bandSteering` | boolean | read-only | Indicate if frequencies 2.4GHz and 5GHz are agregated |
| `WLAN[].channel` | integer | read-only | Channel number (Useless if channelMode is set to Auto) |
| `WLAN[].channelMode` | xdsl.xdslModemConfig.ChannelModeEnum | read-only | How the WiFi channel is selected — one of `Auto`, `Manual` |
| `WLAN[].enabled` | boolean | read-only | Wifi state |
| `WLAN[].frequency` | xdsl.xdslModemConfig.FrequencyEnum | read-only | Modem frequency — one of `2.4GHz`, `5GHz` |
| `WLAN[].guest` | boolean | read-only | Indicate if it is normal access wifi or guest wifi |
| `WLAN[].securityKey` | string (password) | read-only | Encrypted WLAN passphrase |
| `WLAN[].securityType` | xdsl.templateModem.SecurityTypeEnum | read-only | Type of WLAN security protection — one of `None`, `WPA`, `WPA2`, `WPA2andWPA3`, `WPA3`, `WPAandWPA2` |
| `WLAN[].wifiName` | string | read-only | Wifi Name |
| `capabilities` | string | read-only | Parameters capabilities. Lists what can be applied from this template |
| `creationDate` | string (date-time) | read-only | Template creation date |
| `dmzIP` | ip | read-only | IP Address of the DMZ |
| `mtuSize` | xdsl.xdslModemConfig.MTUSizeEnum | read-only | Size of the Maximum Transmission Unit on the modem's interfaces — one of `1432`, `1456`, `1492` |
| `name` | string | read-only | Name of the Modem Template |
| `parametersToIgnore` | xdsl.templateModem.ParametersToIgnore |  | Do not apply these parameters from template. You can use parametersCapabilities to know availability |
| `parametersToIgnore.LANandDHCP` | boolean |  | Ignore LAN and DHCP configurations |
| `parametersToIgnore.WLANList` | string[] |  | WLAN names list to ignore. Ignore only listed WLAN |
| `parametersToIgnore.dmzIP` | boolean |  | Ignore DMZ configuration |
| `parametersToIgnore.mtuSize` | boolean |  | Ignore MTU Size value |
| `parametersToIgnore.portMappingList` | string[] |  | PortMapping names list to ignore. Ignore only listed portMapping |
| `portMapping` | xdsl.templateModem.PortMapping[] | read-only | List of PortMapping for this template |
| `portMapping[].allowedRemoteIp` | ipv4 | read-only | An ip which will access to the defined rule. Default : no restriction applied |
| `portMapping[].description` | string | read-only | Description of the Port Mapping |
| `portMapping[].externalPortEnd` | integer | read-only | The last port of the interval on the External Client that will get the connections |
| `portMapping[].externalPortStart` | integer | read-only | External Port that the modem will listen on. List of externalPorts not available for now in the API : 8, 21, 68, 5060, 21800-21805, 51005 |
| `portMapping[].internalClient` | ip | read-only | IP address (e.g., 192.0.2.0) |
| `portMapping[].internalPort` | integer | read-only | The port on the Internal Client that will get the connections |
| `portMapping[].name` | string | read-only | Name of the port mapping entry |
| `portMapping[].protocol` | xdsl.xdslModemConfig.ProtocolTypeEnum | read-only | Type of protocol for the Port Mapping — one of `TCP`, `UDP` |

```json
{
  "DHCP": [
    {
      "defaultGateway": "192.0.2.0",
      "dhcpName": "string",
      "domainName": "string",
      "endAddress": "192.0.2.0",
      "leaseTime": 0,
      "primaryDNS": "192.0.2.0",
      "secondaryDNS": "192.0.2.0",
      "serverEnabled": true,
      "startAddress": "192.0.2.0",
      "subnetMask": "192.0.2.0"
    }
  ],
  "LAN": [
    {
      "IPAddress": "192.0.2.0",
      "addressingType": "DHCP",
      "lanName": "string",
      "subnetMask": "192.0.2.0"
    }
  ],
  "WLAN": [
    {
      "SSID": "string",
      "SSIDAdvertisementEnabled": true,
      "bandSteering": true,
      "channel": 0,
      "channelMode": "Auto",
      "enabled": true,
      "frequency": "2.4GHz",
      "guest": true,
      "securityKey": "string",
      "securityType": "None",
      "wifiName": "string"
    }
  ],
  "capabilities": "string",
  "creationDate": "2024-01-01T12:00:00Z",
  "dmzIP": "192.0.2.0",
  "mtuSize": 1432,
  "name": "string",
  "parametersToIgnore": {
    "LANandDHCP": true,
    "WLANList": [
      "string"
    ],
    "dmzIP": true,
    "mtuSize": true,
    "portMappingList": [
      "string"
    ]
  },
  "portMapping": [
    {
      "allowedRemoteIp": "192.0.2.0",
      "description": "string",
      "externalPortEnd": 0,
      "externalPortStart": 0,
      "internalClient": "192.0.2.0",
      "internalPort": 0,
      "name": "string",
      "protocol": "TCP"
    }
  ]
}
```

### Example

```bash
curl -X GET \
  "https://api.eu.ovhcloud.com/1.0/xdsl/templateModem/{name}" \
  -H "accept: application/json" \
  -H "authorization: Bearer $OVH_TOKEN"
```

```python
'''
First, install the latest release of Python wrapper: $ pip install ovh
'''
import json
import ovh

# Instantiate an OVH Client.
# You can generate new credentials with full access to your account on
# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
client = ovh.Client(
	endpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
	application_key='xxxxxxxxxx',    # Application Key
	application_secret='xxxxxxxxxx', # Application Secret
	consumer_key='xxxxxxxxxx',       # Consumer Key
)

result = client.get("/xdsl/templateModem/{name}")

# Pretty print
print(json.dumps(result, indent=4))
```

```php
<?php
/**
 * First, download the latest release of PHP wrapper on github
 * And include this script into the folder with extracted files
 */
require __DIR__ . '/vendor/autoload.php';
use \Ovh\Api;

/**
 * Instantiate an OVH Client.
 * You can generate new credentials with full access to your account on
 * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
 */
$ovh = new Api('xxxxxxxxxx',  // Application Key
               'xxxxxxxxxx',  // Application Secret
               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
               'xxxxxxxxxx'); // Consumer Key

$result = $ovh->get("/xdsl/templateModem/{name}");

print_r($result);
?>
```

## Update a modem template

`PUT /1.0/xdsl/templateModem/{name}`

Link: https://developers.eu.ovhcloud.com/reference/web-cloud/internet/access/modem/templates/#updateModemTemplate

**Status:** Stable production version  
**IAM actions:** `account:apiovh:xdslTemplateModem/edit`

Changes the parameters to ignore when the template is applied to a modem.

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `name` | path | string | yes | Name |

### Request body (required)

Type: `xdsl.TemplateModem`

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `DHCP` | xdsl.templateModem.DHCP[] | read-only | List of DHCP for this template |
| `DHCP[].defaultGateway` | ip | read-only | IP address (e.g., 192.0.2.0) |
| `DHCP[].dhcpName` | string | read-only | Name of the DHCP |
| `DHCP[].domainName` | string | read-only | Domain name provided to the clients |
| `DHCP[].endAddress` | ip | read-only | IP address (e.g., 192.0.2.0) |
| `DHCP[].leaseTime` | integer | read-only | Lease time in seconds of client assigned address (-1 means infinite) |
| `DHCP[].primaryDNS` | ip | read-only | IP address (e.g., 192.0.2.0) |
| `DHCP[].secondaryDNS` | ip | read-only | Secondary DNS servers to be given to the clients |
| `DHCP[].serverEnabled` | boolean | read-only | State of the DHCP server of the modem |
| `DHCP[].startAddress` | ip | read-only | IP address (e.g., 192.0.2.0) |
| `DHCP[].subnetMask` | ip | read-only | IP address (e.g., 192.0.2.0) |
| `LAN` | xdsl.templateModem.LAN[] | read-only | List of LAN for this template |
| `LAN[].IPAddress` | ip | read-only | IP address (e.g., 192.0.2.0) |
| `LAN[].addressingType` | xdsl.xdslModemConfig.AddressingTypeEnum | read-only | How the modem gets its LAN IP Address — one of `DHCP`, `Static` |
| `LAN[].lanName` | string | read-only | Name of the LAN |
| `LAN[].subnetMask` | ip | read-only | IP address (e.g., 192.0.2.0) |
| `WLAN` | xdsl.templateModem.WLAN[] | read-only | List of WLAN for this template |
| `WLAN[].SSID` | string | read-only | Service Set Identifier of the WLAN interface |
| `WLAN[].SSIDAdvertisementEnabled` | boolean | read-only | Control if Wifi is discoverable or hidden |
| `WLAN[].bandSteering` | boolean | read-only | Indicate if frequencies 2.4GHz and 5GHz are agregated |
| `WLAN[].channel` | integer | read-only | Channel number (Useless if channelMode is set to Auto) |
| `WLAN[].channelMode` | xdsl.xdslModemConfig.ChannelModeEnum | read-only | How the WiFi channel is selected — one of `Auto`, `Manual` |
| `WLAN[].enabled` | boolean | read-only | Wifi state |
| `WLAN[].frequency` | xdsl.xdslModemConfig.FrequencyEnum | read-only | Modem frequency — one of `2.4GHz`, `5GHz` |
| `WLAN[].guest` | boolean | read-only | Indicate if it is normal access wifi or guest wifi |
| `WLAN[].securityKey` | string (password) | read-only | Encrypted WLAN passphrase |
| `WLAN[].securityType` | xdsl.templateModem.SecurityTypeEnum | read-only | Type of WLAN security protection — one of `None`, `WPA`, `WPA2`, `WPA2andWPA3`, `WPA3`, `WPAandWPA2` |
| `WLAN[].wifiName` | string | read-only | Wifi Name |
| `capabilities` | string | read-only | Parameters capabilities. Lists what can be applied from this template |
| `creationDate` | string (date-time) | read-only | Template creation date |
| `dmzIP` | ip | read-only | IP Address of the DMZ |
| `mtuSize` | xdsl.xdslModemConfig.MTUSizeEnum | read-only | Size of the Maximum Transmission Unit on the modem's interfaces — one of `1432`, `1456`, `1492` |
| `name` | string | read-only | Name of the Modem Template |
| `parametersToIgnore` | xdsl.templateModem.ParametersToIgnore |  | Do not apply these parameters from template. You can use parametersCapabilities to know availability |
| `parametersToIgnore.LANandDHCP` | boolean |  | Ignore LAN and DHCP configurations |
| `parametersToIgnore.WLANList` | string[] |  | WLAN names list to ignore. Ignore only listed WLAN |
| `parametersToIgnore.dmzIP` | boolean |  | Ignore DMZ configuration |
| `parametersToIgnore.mtuSize` | boolean |  | Ignore MTU Size value |
| `parametersToIgnore.portMappingList` | string[] |  | PortMapping names list to ignore. Ignore only listed portMapping |
| `portMapping` | xdsl.templateModem.PortMapping[] | read-only | List of PortMapping for this template |
| `portMapping[].allowedRemoteIp` | ipv4 | read-only | An ip which will access to the defined rule. Default : no restriction applied |
| `portMapping[].description` | string | read-only | Description of the Port Mapping |
| `portMapping[].externalPortEnd` | integer | read-only | The last port of the interval on the External Client that will get the connections |
| `portMapping[].externalPortStart` | integer | read-only | External Port that the modem will listen on. List of externalPorts not available for now in the API : 8, 21, 68, 5060, 21800-21805, 51005 |
| `portMapping[].internalClient` | ip | read-only | IP address (e.g., 192.0.2.0) |
| `portMapping[].internalPort` | integer | read-only | The port on the Internal Client that will get the connections |
| `portMapping[].name` | string | read-only | Name of the port mapping entry |
| `portMapping[].protocol` | xdsl.xdslModemConfig.ProtocolTypeEnum | read-only | Type of protocol for the Port Mapping — one of `TCP`, `UDP` |

```json
{
  "parametersToIgnore": {
    "LANandDHCP": true,
    "WLANList": [
      "string"
    ],
    "dmzIP": true,
    "mtuSize": true,
    "portMappingList": [
      "string"
    ]
  }
}
```

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | — | successful operation |

### Example

```bash
curl -X PUT \
  "https://api.eu.ovhcloud.com/1.0/xdsl/templateModem/{name}" \
  -H "accept: application/json" \
  -H "authorization: Bearer $OVH_TOKEN" \
  -H "content-type: application/json" \
  -d '{ }'
```

```python
'''
First, install the latest release of Python wrapper: $ pip install ovh
'''
import json
import ovh

# Instantiate an OVH Client.
# You can generate new credentials with full access to your account on
# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
client = ovh.Client(
	endpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
	application_key='xxxxxxxxxx',    # Application Key
	application_secret='xxxxxxxxxx', # Application Secret
	consumer_key='xxxxxxxxxx',       # Consumer Key
)

# Request body type: xdsl.TemplateModem
result = client.put("/xdsl/templateModem/{name}",
	parametersToIgnore = None, # Do not apply these parameters from template. You can use parametersCapabilities to know availability (type: xdsl.templateModem.ParametersToIgnore, nullable)
)

# Pretty print
print(json.dumps(result, indent=4))
```

```php
<?php
/**
 * First, download the latest release of PHP wrapper on github
 * And include this script into the folder with extracted files
 */
require __DIR__ . '/vendor/autoload.php';
use \Ovh\Api;

/**
 * Instantiate an OVH Client.
 * You can generate new credentials with full access to your account on
 * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
 */
$ovh = new Api('xxxxxxxxxx',  // Application Key
               'xxxxxxxxxx',  // Application Secret
               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
               'xxxxxxxxxx'); // Consumer Key

// Request body type: xdsl.TemplateModem
$result = $ovh->put("/xdsl/templateModem/{name}", array(
	parametersToIgnore => null, // Do not apply these parameters from template. You can use parametersCapabilities to know availability (type: xdsl.templateModem.ParametersToIgnore, nullable)
));

print_r($result);
?>
```

## Delete a modem template

`DELETE /1.0/xdsl/templateModem/{name}`

Link: https://developers.eu.ovhcloud.com/reference/web-cloud/internet/access/modem/templates/#deleteModemTemplate

**Status:** Stable production version  
**IAM actions:** `account:apiovh:xdslTemplateModem/delete`

Deletes the modem template and all its settings.

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `name` | path | string | yes | Name |

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | — | successful operation |

### Example

```bash
curl -X DELETE \
  "https://api.eu.ovhcloud.com/1.0/xdsl/templateModem/{name}" \
  -H "accept: application/json" \
  -H "authorization: Bearer $OVH_TOKEN"
```

```python
'''
First, install the latest release of Python wrapper: $ pip install ovh
'''
import json
import ovh

# Instantiate an OVH Client.
# You can generate new credentials with full access to your account on
# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
client = ovh.Client(
	endpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
	application_key='xxxxxxxxxx',    # Application Key
	application_secret='xxxxxxxxxx', # Application Secret
	consumer_key='xxxxxxxxxx',       # Consumer Key
)

result = client.delete("/xdsl/templateModem/{name}")

# Pretty print
print(json.dumps(result, indent=4))
```

```php
<?php
/**
 * First, download the latest release of PHP wrapper on github
 * And include this script into the folder with extracted files
 */
require __DIR__ . '/vendor/autoload.php';
use \Ovh\Api;

/**
 * Instantiate an OVH Client.
 * You can generate new credentials with full access to your account on
 * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
 */
$ovh = new Api('xxxxxxxxxx',  // Application Key
               'xxxxxxxxxx',  // Application Secret
               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
               'xxxxxxxxxx'); // Consumer Key

$result = $ovh->delete("/xdsl/templateModem/{name}");

print_r($result);
?>
```