Configurações do Serviço

Esta é uma API de gerenciamento da configuraçõe do serviço DHCP

Buscar configuração do serviço DHCP

API para buscar configuração do DHCP.

GET /api/dhcp/service

Exemplo de requisição

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

response = sdk.dhcp.get_service_config(request)

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

Exemplo de resposta

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

{
  "lease_lfc_interval": 3600,
  "valid_life_time": 4000,
  "renew_timer": 1000,
  "rebind_timer": 2000,
  "tftp_next_server": "",
  "tftp_boot_file_name": "",
  "options": [
    {
      "code": 10,
      "custom_id": null,
      "value": "192.168.10.10",
    },
  ],
  "created_at": "2017-10-05T12:20:02.932000+00:00",
  "updated_at": "2017-11-05T12:20:02.932000+00:00",
}

if response.success:
    return response.payload

{
  leaseLfcInterval: 3600,
  validLifeTime: 4000,
  renewTimer: 1000,
  rebindTimer: 2000,
  tftpNextServer: "",
  tftpBootFileName: "",
  options: [
    {
      code: 10,
      customId: null,
      value: "192.168.10.10"
    }
  ],
  createdAt: "2017-10-05T12:20:02.932000+00:00",
  updatedAt: "2017-11-05T12:20:02.932000+00:00"
}

Editar configuração do serviço DHCP

API para edição da configuração do serviço DHCP

PUT /api/dhcp/service

Exemplo de requisição

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

{
  "apply": true,
  "lease_lfc_interval": 3600,
  "valid_life_time": 4000,
  "renew_timer": 1000,
  "rebind_timer": 2000,
  "tftp_next_server": "",
  "tftp_boot_file_name": "",
  "options": [
    {
      "code": 10,
      "custom_id": null,
      "value": "192.168.10.10",
    },
  ],
}

from itflex_sdk.dhcp.types import UpdateServiceConfigRequest, Option

request = UpdateServiceConfigRequest(
    apply=True,
    lease_lfc_interval=3600,
    valid_life_time=4000,
    renew_timer=1000,
    rebind_timer=2000,
    tftp_next_server="",
    tftp_boot_file_name="",
    options=[
        Option(
            code=10,
            custom_id=None,
            value="192.168.10.10",
        ),
    ],
)
response = sdk.dhcp.update_service_config(request)

const response = await sdk.dhcp.updateServiceConfig({
  apply: true,
  leaseLfcInterval: 3600,
  validLifeTime: 4000,
  renewTimer: 1000,
  rebindTimer: 2000,
  tftpNextServer: "",
  tftpBootFileName: "",
  options: [
    {
      code: 10,
      customId: null,
      value: "192.168.10.10"
    }
  ]
});
console.log(response.payload);

Exemplo de resposta

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

{
  "lease_lfc_interval": 3600,
  "valid_life_time": 4000,
  "renew_timer": 1000,
  "rebind_timer": 2000,
  "tftp_next_server": "",
  "tftp_boot_file_name": "",
  "options": [
    {
      "code": 10,
      "custom_id": null,
      "value": "192.168.10.10",
    },
  ],
  "created_at": "2017-10-05T12:20:02.932000+00:00",
  "updated_at": "2017-11-05T12:20:02.932000+00:00",
}

if response.success:
    return response.payload

{
  leaseLfcInterval: 3600,
  validLifeTime: 4000,
  renewTimer: 1000,
  rebindTimer: 2000,
  tftpNextServer: "",
  tftpBootFileName: "",
  options: [
    {
      code: 10,
      customId: null,
      value: "192.168.10.10",
    },
  ],
  createdAt: "2017-10-05T12:20:02.932000+00:00",
  updatedAt: "2017-11-05T12:20:02.932000+00:00",
}

Aplicar configurações do serviço DHCP

API para aplicar as configurações do serviço DHCP

POST /api/dhcp/service/apply

Exemplo de requisição

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

response = sdk.dhcp.apply()

const response = await sdk.dhcp.apply();

Exemplo de resposta

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

Formato dos dados

Requisição

Parâmetro Tipo Valor Default Descrição
apply bool False Flag para aplicar o provisionamento das configurações do serviço DHCP
lease_lfc_interval int 3600 Intervalo de tempo (em segundos) para limpar o arquivo de leases
valid_life_time int 4000 Define quanto tempo (em segundos) os endereços de lease fornecidos pelo servidor são validos
renew_timer int 1000 Define o intervalo de tempo (em segundos) em que o cliente iniciará o processo renovação solicitando a concessão de um novo endereço à um servidor DHCP.
rebind_timer int 2000 Define o intervalo de tempo (em segundos) em que o cliente iniciará o processo reativação para solicitar concessão de endereço à todos os servidores DHCP.
tftp_next_server string Endereço IP do servidor TFTP
tftp_boot_file_name srting Diretório do arquivo de inicialização do servidor TFTP
options.code int Código da opção DHCP padrão
options.custom_id int Identificador da opção DHCP customizada
options.value string Conteúdo da opção

Resposta

Parâmetro Tipo Descrição
lease_lfc_interval integer Intervalo de tempo (em segundos) para limpar o arquivo de leases
valid_life_time integer Define quanto tempo (em segundos) os endereços de lease fornecidos pelo servidor são validos
renew_timer integer Define o intervalo de tempo (em segundos) em que o cliente iniciará o processo renovação solicitando a concessão de um novo endereço à um servidor DHCP.
rebind_timer integer Define o intervalo de tempo (em segundos) em que o cliente iniciará o processo reativação para solicitar concessão de endereço à todos os servidores DHCP.
tftp_next_server srting Endereço IP do servidor TFTP
tftp_boot_file_name string Diretório do arquivo de inicialização do servidor TFTP
options.code int Código da opção DHCP padrão
options.custom_id int Identificador da opção DHCP customizada
options.value string Conteúdo da opção
created_at datetime Data de criação
updated_at datetime Data de edição