user-awareness – a family of commands for configuring the User awareness functionality

ngfw> user-database-settings

Go to user database configuration submenu.

ngfw> user-database-settings> [no] update-enabled

Enable (or disable, if no) user database update.

ngfw> user-database-settings> user-service-host <host>

Specify the host (address or FQDN) of the UAWS service that matches users to IP addresses.

ngfw> user-database-settings> load-ca-cert <filepath>

Upload CA certificate.

ngfw> user-database-settings> load-client-cert <filepath>

Upload client certificate.

ngfw> user-database-settings> load-client-private-key <filepath>

Upload client private key.

ngfw> user-database-settings> user-service-port <port>

Specify the port of the UAWS service that matches users to IP addresses. By default, 443.

ngfw> user-database-settings> user-service-update-period <period>

Set the period in seconds for requesting updates from the UAWS service that matches users to IP addresses.

ngfw> user-database-settings> groups-service-host <host>

Specify the host (address or FQDN) of the UAWS service that matches groups and users.

ngfw> user-database-settings> groups-service-port <port>

Specify the port of the UAWS service that matches groups and users. By default, 443.

ngfw> user-database-settings> groups-service-update-period <period>

Set the period in seconds for requesting updates from the UAWS service that matches groups and users.

ngfw> show user-database-settings

Show user database settings.

Example output:

ngfw> show user-database-settings
{
  "ngfw-user-awareness:user-database": {
    "settings": {
      "update-enabled": true,
      "user-service": {
        "host": 10.0.2.2,
        "port": 13377,
        "update-period": 5
      },
      "groups-service": {
        "host": 10.0.2.2,
        "port": 3222,
        "update-period": 60
      }
    }
  }
}

ngfw> show user-awareness groups [limit <limit>]

Show all user groups in the database. If the limit setting is specified, the command output contains up to the specified number of user groups.

Example output:

ngfw> show user-awareness groups
{
  "ngfw-user-awareness:show-groups": {
    "groups": [
      {
        "name": "group2@domain1",
        "users": [
          "user6@domain1",
          "user2@domain1",
          "user1@domain1"
        ]
      },
      {
        "name": "group1@domain1",
        "users": [
          "admin@domain1",
          "user3@domain1",
          "user2@domain1",
          "user1@domain1"
        ]
      }
    ]
  }
}

Example output with limited number of groups:

ngfw> show user-awareness groups limit 1
{
  "ngfw-user-awareness:show-groups": {
    "groups": [
      {
        "name": "group2@domain1",
        "users": [
          "user6@domain1",
          "user2@domain1",
          "user1@domain1"
        ]
      }
    ]
  }
}

ngfw> show user-awareness group <group_name>

Show all users in group <group_name>.

Example output:

ngfw> show user-awareness group group2@domain1
{
  "ngfw-user-awareness:show-group": {
    "users": [
      "user6@domain1",
      "user2@domain1",
      "user1@domain1"
    ]
  }
}

ngfw> show user-awareness users [limit <limit>]

Show all users in the database. If the limit setting is specified, the command output contains up to the specified number of users.

Example output:

ngfw> show user-awareness users
{
  "ngfw-user-awareness:show-users": {
    "users": [
      {
        "name": "user6@domain1",
        "address": "1.1.1.10"
      },
      {
        "name": "user1@domain1",
        "address": "1.1.1.1"
      },
      {
        "name": "user3@domain1",
        "address": "1.1.1.7"
      },
      {
        "name": "user2@domain1",
        "address": "1.1.1.2"
      },
      {
        "name": "admin@domain1",
        "address": "1.1.1.3"
      }
    ]
  }
}

Example output with limited number of users:

ngfw> show user-awareness users limit 2
{
  "ngfw-user-awareness:show-users": {
    "users": [
      {
        "name": "user6@domain1",
        "address": "1.1.1.10"
      },
      {
        "name": "user1@domain1",
        "address": "1.1.1.1"
      }
    ]
  }
}

ngfw> show user-awareness user <user_name>

Show information about user <user_name>.

Example output:

ngfw> show user-awareness user user1@domain1
{
  "ngfw-user-awareness:show-user": {
    "address": "1.1.1.1"
  }
}

| Prev | Home | Next |