FortiManager Service

4 min

Resumo

Gerencia as configurações do FortiManager Service usando a API jsonrpc

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.
category	list	Uncategorized Authentication Email File Acces General Network Services Remote Access Tunneling VoIP Messagin & Other Applications Web Access Web Proxy	A categoria do objeto de serviço.
color	interger		Uma tag que pode ser usada para agrupar objetos.
comment	string		Um comentário para adicionar ao VIP.
explicit_proxy	string		Usado para definir o serviço de proxy explícito para o objeto Service.
icmp_code	interger		O código ICMP para quando o protocolo é definido como ICMP.
icmp_type	interger		O tipo de ICMP para quando o protocolo é definido como ICMP.
port_range	list		O intervalo de portas TCP ou UDP associado ao objeto de serviço
protocol	list	ICMP IP TCP UDP SCTP ICMP6 HTTP FTP CONNECT ALL SOCKS-TCP SOCKS-UDP	Usado para especificar o tipo de protocolo do serviço.
protocol_number	string		Usado para especificar o número do protocolo IP quando o protocolo é definido como IP.
service_name	string		O nome do serviço.

Exemplos

- name: Add Service Object
  fortimgr_service:
    host: "{{ ansible_host }}"
    username: "{{ ansible_user }}"
    password: "{{ ansible_password }}"
    adom: "lab"
    service_name: "App01_Web"
    protocol: "TCP"
    port_range:
      - "80"
      - "443"
      - "8443"
    comment: "App01 Web Services"
- name: Remove Port from Service
  fortimgr_service:
    host: "{{ ansible_host }}"
    username: "{{ ansible_user }}"
    password: "{{ ansible_password }}"
    adom: "lab"
    service_name: "App01_Web"
    protocol: "TCP"
    port_range: "80"
    validate_certs: True
    state: "param_absent"
- name: Add ICMP Service Object
  fortimgr_service:
    host: "{{ ansible_host }}"
    username: "{{ ansible_user }}"
    password: "{{ ansible_password }}"
    adom: "lab"
    service_name: "ICMP_Echo"
    protocol: "ICMP"
    icmp_code: 0
    icmp_type: 8
- name: Delete Service Object
  fortimgr_service:
    host: "{{ ansible_host }}"
    username: "{{ ansible_user }}"
    password: "{{ ansible_password }}"
    use_ssl: False
    adom: "lab"
    service_name: "App01_Web"
    state: "absent"

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