Opções DHCP

Esta é uma API de gerenciamento da opções DHCP.

Listar opções DHCP

API de listagem de opções DHCP. Esta API inclui opções padrões e customizadas.

GET /api/dhcp/options

Exemplo de requisição

GET /api/dhcp/options HTTP/1.1
Host: api.exemplo.com
Accept: application/json
Authorization: Bearer <Access-Token>

response = sdk.dhcp.get_options()

const response = sdk.dhcp.getOptions();
console.log(response.payload);

Exemplo de resposta

HTTP/1.1 200 OK
Content-Type: application/json

{
  "options": [
    {
      "custom_id": 1,
      "code": 100,
      "name": "custom-domains",
      "created_at": "2017-10-05T12:20:02.932000+00:00",
      "updated_at": "2017-11-05T12:20:02.932000+00:00",
    },
    {
      "custom_id": null,
      "code": 10,
      "name": "dns-options",
      "created_at": null,
      "updated_at": null,
    },
  ],
}

if response.success:
    return response.payload

[
  {
    customId: 1,
    code: 100,
    name: "custom-domains",
    createdAt: "2017-10-05T12:20:02Z",
    updatedAt: "2017-11-05T12:20:02Z"
  },
  {
    customId: null,
    code: 10,
    name: "dns-options",
    createdAt: null,
    updatedAt: null
  }
];

Cadastrar opção DHCP customizada

API de cadastro de uma opção DHCP customizada.

POST /api/dhcp/options

Exemplo de requisição

POST /api/dhcp/options HTTP/1.1
Host: api.exemplo.com
Accept: application/json
Authorization: Bearer <Access-Token>

{
  "code": 100,
  "name": "cutom-domains",
}

from itflex_sdk.dhcp.types import CreateOptionRequest

request = CreateOptionRequest(
    code=100,
    name="cutom-domains",
)
response = sdk.dhcp.create_option(request)

const option = sdk.dhcp.types.Option();
option.code = 100;
option.name = "custom-domains";

const response = await sdk.dhcp.createOption(option);
console.log(response.payload);

Exemplo de resposta

HTTP/1.1 200 OK
Content-Type: application/json

{
  "custom_id": 1,
  "code": 100,
  "name": "custom-domains",
  "created_at": "2017-10-05T12:30:02.932000+00:00",
  "updated_at": "2017-11-05T12:30:02.932000+00:00",
}

if response.success:
    return response.payload

{
  customId: 1,
  code: 100,
  name: "custom-domains",
  createdAt: "2017-10-05T12:30:02Z",
  updatedAt: "2017-20-05T12:30:02Z",
}

Editar opção DHCP customizada

API de edição de uma opção DHCP customizada.

PUT /api/dhcp/options/<custom_id>

Exemplo de requisição

PUT /api/dhcp/options/1 HTTP/1.1
Host: api.exemplo.com
Accept: application/json
Authorization: Bearer <Access-Token>

{
  "custom_id": 1,
  "code": 110,
  "name": "custom-domains-updated",
}

from itflex_sdk.dhcp.types import UpdateOptionRequest

request = UpdateOptionRequest(
    custom_id=1,
    code=110,
    name="cutom-domains-updated",
)
response = sdk.dhcp.update_option(request)

const option = {
  customId: 1,
  code = 110,
  name = "custom-domains-updated",
};

const response = await sdk.dhcp.updateOption(option);
console.log(response.payload);

Exemplo de resposta

HTTP/1.1 200 OK
Content-Type: application/json

{
  "custom_id": 1,
  "code": 110,
  "name": "custom-domains-updated",
  "created_at": "2017-10-05T12:30:02.932000+00:00",
  "updated_at": "2017-11-05T12:30:04.932000+00:00",
}

if response.success:
    return response.payload

{
  customId: 1,
  code: 100,
  name: "custom-domains",
  createdAt: "2017-10-05T12:30:02Z",
  updatedAt: "2017-20-05T12:30:04Z",
}

Excluir opção DHCP customizada

API de exclusão de uma opção DHCP customizada.

DELETE /api/dhcp/options/<custom_id>

Exemplo de requisição

DELETE /api/dhcp/options/1 HTTP/1.1
Host: api.exemplo.com
Accept: application/json
Authorization: Bearer <Access-Token>

response = sdk.dhcp.delete_option(custom_id=1)

const response = await sdk.dhcp.deleteOption({ customId: 1 });
console.log(response);

Exemplo de resposta

HTTP/1.1 200 OK
Content-Type: application/json

return response.success

Formato dos dados

Parâmetros da url

Parâmetro Tipo Descrição
custom_id integer Identificador da opção DHCP customizada

Requisição

Parâmetro Tipo Valor Default Descrição
code integer
requerido único		 Código de identificação da opção DHCP
name string
requerido único		 Nome da opção DHCP
Tamanho máximo: 30

Resposta

Parâmetro Tipo Descrição
custom_id int Identificador da opção DHCP customizada
code int Código de identificação da opção DHCP
name string Nome da opção DHCP
created_at datetime Data de criação
updated_at datetime Data da última edição