FortiManager Route

4 min

Resumo

Gerencia as configurações de rota do FortiGate usando a API jsonrpc do FortiManager

Parâmetros

Parâmetro	Tipo	Escolhas \| Valor Padrão	Comentários
adom	string		O ADOM ao qual a configuração deve pertencer.
host	string		Endereço do FortiManager.
lock	bool		True bloqueia o ADOM, faz as atualizações de configuração necessárias, salva a configuração e desbloqueia o ADOM.
password	string		A senha associada à conta de nome de usuário.
port	interger		A porta TCP usada para conectar ao FortiManager se for diferente do padrão usado pelo método de transporte (http=80, https=443)..
provider	dict		Dicionário que atua como uma coleção de argumentos usados para definir as características de como se conectar ao dispositivo. Os argumentos hostname, username e password devem ser especificados no provedor ou no parâmetro local. Parâmetros locais têm precedência, por ex. hostname é preferível a provider["hostname"] quando ambos são especificados.
session_id	string		O session_id de uma sessão estabelecida e ativa.
state	string	present absent param_absent	O estado desejado do objeto especificado. Ausente excluirá o mapeamento do objeto, se existir. Param_absent removerá os parâmetros passados da configuração do objeto, se necessário e possível. Presente criará configuração para o mapeamento correlacionado ao fortigate especificado, se necessário.
use_ssl	bool		Determina se deve usar HTTPS(True) ou HTTP(False).
username	string		O nome de usuário usado para autenticar com o FortiManager.
validate_certs	bool		Determina se deve validar os certificados em um arquivo de certificado confiável (True) ou aceitar todos os certificados.
comment	string		Um comentário para adicionar ao VIP.
distance	string		A métrica de distância a associar à rota.
destination	string		A sub-rede de destino. Isso suporta o envio de uma string como notação cidr ou uma lista de dois elementos que seria retornado ao obter objetos de endereço existentes. Alternativamente, a máscara de rede e os parâmetros de rede podem ser usados.
destination_netmask	string		A máscara de rede a ser usada para o endereço de destino. O parâmetro de rede deve ser usado em conjunto com a máscara de rede. Como alternativa, o parâmetro de destino pode ser usado para notação cidr.
destination_network	string		O endereço de rede para usar o endereço de destino. O parâmetro netmask deve ser usado em conjunto com network. Como alternativa, o parâmetro de destino pode ser usado para notação cidr.
destination_object	string		O endereço ou objeto de grupo de endereços a ser usado como endereço de destino
fortigate	string		O nome do forte para o qual mapear a configuração.
gateway	list		O endereço de gateway para o qual o destino pode ser alcançado.
intfc	list		A interface usada para alcançar a rota.
priority	interger		A prioridade para atribuir a rota.
sequence_number	interger		O número de sequência da rota no FortiManager Isso é necessário para modificar a interface, o destino e o gateway de uma rota existente.
vdom	string		O vdom no fortigate ao qual a configuração deve ser associada.
weight	interger		O peso a atribuir ao percurso.

Exemplos

- name: Add Route
  fortimgr_route:
    host: "{{ host }}"
    username: "{{ user }}"
    password: "{{ password }}"
    state: "present"
    adom: "lab"
    fortigate: "lab_fg"
    vdom: "root"
    destination: "10.2.1.0/24"
    gateway: "10.1.1.1"
    intfc: "port1"
- name: Remove Route
  fortimgr_route:
    host: "{{ host }}"
    username: "{{ user }}"
    password: "{{ password }}"
    state: "absent"
    adom: "lab"
    fortigate: "lab_fg"
    vdom: "root"
    destination: "10.2.1.0/24"
    gateway: "10.1.1.1"

Valores retornados

Chave	Tipo	Retornado quando	Descrição
existing	dict	Sempre	A configuração dynamic_mapping existente para o VIP (usa vip_name) antes da execução da tarefa.
config	dict	Sempre	A configuração que foi enviada para o FortiManager.
locked	bool	Quando é definido como True	O status do comando de bloqueio ADOM
saved	bool	Quando é definido como True	O status do comando ADOM save
unloked	bool	Quando é definido como True	O status do comando de desbloqueio ADOM