FortiOS User Group

8 min

Resumo

Este módulo é capaz de configurar um dispositivo FortiGate ou FortiOS (FOS), permitindo ao usuário definir e modificar características do usuário e categoria de grupo. Os exemplos incluem todos os parâmetros e valores que precisam ser ajustados às fontes de dados antes do uso. Testado com FOS v6.0.0

Parâmetros

Parâmetro	Tipo	Escolhas \| Valor Padrão	Comentários
access_token	string		Autenticação baseada em token. Gerado a partir da GUI do Fortigate.
enable_log	boolean	Escolhas: - false(default) - true	Habilite / desabilite o registro da tarefa.
state - required	string	Escolhas: - present - absent	Indica se deve criar ou remover o objeto.
user_device_group	dictionary		Configure grupos de dispositivos.
vdom	string	Default: "root"	Domínio virtual, entre os definidos anteriormente. A vdom é uma instância virtual do FortiGate que pode ser configurada e usada como uma unidade diferente.

Subcampos da opção user_group

Parâmetro	Tipo	Escolhas \| Valor Padrão	Comentários
auth_concurrent_override	string	Escolhas: - enable - disable	Ative / desative a substituição do número global de sessões de autenticação simultâneas para este grupo de usuários.
auth_concurrent_value	integer		Número máximo de conexões autenticadas simultâneas por usuário (0 - 100).
authtimeout	integer		Tempo limite de autenticação em minutos para este grupo de usuários. 0 para usar o tempo limite de autenticação da configuração global do usuário.
company	string	Escolhas: - optional - mandatory - disabled	Defina a ação para o campo de usuário convidado da empresa.
email	string	Escolhas: - enable - disable	Habilite / desabilite o campo de endereço de e-mail do usuário convidado.
expire	integer		Tempo em segundos antes que as contas de usuário convidado expirem. (1 - 31536000 seg)
expire_type	string	Escolhas: - firewall - fsso-service - rsso - guest	Determine quando a contagem regressiva de expiração começa.
group_type	string		Defina o grupo para autenticação de firewall, FSSO, RSSO ou usuários convidados.
guest	list / elements=string		Usuário convidado.
http_digest_realm	string		Atributo de domínio para autenticação MD5-digest.
id	integer		ID do grupo.
match	list / elements=string		Jogos de grupo.
max_accounts	integer		Número máximo de contas de convidados que podem ser criadas para este grupo (0 significa ilimitado).
member	list / elements=string		Nomes de usuários, pares, servidores LDAP ou servidores RADIUS a serem adicionados ao grupo de usuários.
mobile_phone	string	Escolhas: - enable - disable	Habilita / desabilita o campo do número do celular do usuário convidado.
multiple_guest_add	string	Escolhas: - enable - disable	Ative / desative a adição de vários convidados.
name - required	string		Nome do grupo.
password	string	Escolhas: - auto-generate - specify - disable	Tipo de senha de usuário convidado.
sms_custom_server	string		Servidor SMS.
sms_server	string	Escolhas: - fortiguard - custom	Envie SMS através do FortiGuard ou outro servidor externo.
sponsor	string	Escolhas: - optional - mandatory - disabled	Defina a ação para o campo do usuário convidado do patrocinador.
sso_attribute_value	string		Nome do grupo de usuários RADIUS que este grupo de usuários local representa.
user_id	string	Escolhas: - email - auto-generate - specify	Tipo de ID de usuário convidado.
user_name	string	Escolhas: - disable - enable	Habilite / desabilite a entrada do nome de usuário convidado.

Subcampos da opção guest

Parâmetro	Tipo	Comentários
comment	string	Comente...
company	string	Defina a ação para o campo de usuário convidado da empresa.
email	string	O email.
expiration	string	Tempo de expiração.
id	integer	ID do convidado.
mobile_phone	string	Celular.
name	string	Nome do convidado.
password	string	Senha de convidado.
sponsor	string	Defina a ação para o campo do usuário convidado do patrocinador.
user_id	string	ID do convidado.

Subcampos da opção match

Parâmetro	Tipo	Comentários
group_name	string	Nome do grupo correspondente no servidor de autenticação remoto.
id - required	integer	id.
server_name	string	Nome do servidor de autenticação remoto.

Subcampos da opção member

Parâmetro	Tipo	Escolhas \| Valor Padrão	Comentários
name - required	string		Nome do membro do grupo

Extende fragmentos da documentação dos módulos FortiOS e FotiOS API

Exemplos

- hosts: localhost
  vars:
   host: "192.168.122.40"
   username: "admin"
   password: ""
   vdom: "root"
   ssl_verify: "False"
  tasks:
  - name: Configure device groups.
    fortios_user_device_group:
      host:  "{{ host }}"
      username: "{{ username }}"
      password: "{{ password }}"
      vdom:  "{{ vdom }}"
      https: "False"
      state: "present"
      user_device_group:
        comment: "Comment."
        member:
         -
            name: "default_name_5 (source user.device.alias user.device-category.name)"
        name: "default_name_6"
        tagging:
         -
            category: "<your_own_value> (source system.object-tagging.category)"
            name: "default_name_9"
            tags:
             -
                name: "default_name_11 (source system.object-tagging.tags.name)"

Valores Retornados

Chave	Tipo	Retornado quando	Descrição
build	string	sempre	Número de construção da imagem fortificada
http_method	string	sempre	Último método usado para provisionar o conteúdo no FortiGate
http_status	string	sempre	Último resultado dado por FortiGate na última operação aplicada
mkey	string	sucesso	Chave mestra (id) usada na última chamada para FortiGate
name	string	sempre	Nome da mesa usada para atender ao pedido
path	string	sempre	Caminho da mesa usada para atender ao pedido
revision	string	sempre	Número de revisão interna
serial	string	sempre	Número de série da unidade
status	string	sempre	Indicação do resultado da operação
vdom	string	sempre	Domínio virtual usado
version	string	sempre	Versão do FortiGate