2.9. Hammer auth-source

操作身份验证源

Usage:
    hammer auth-source [OPTIONS] SUBCOMMAND [ARG] ...

Parameters:
 SUBCOMMAND                    Subcommand
 [ARG] ...                     Subcommand arguments

Subcommands:
 external                      Manage external auth sources
 ldap                          Manage LDAP auth sources
 list, index                   List all auth sources

Options:
 -h, --help                    Print help

2.9.1. Hammer auth-source 外部

管理外部身份验证源

Usage:
    hammer auth-source external [OPTIONS] SUBCOMMAND [ARG] ...

Parameters:
 SUBCOMMAND                    Subcommand
 [ARG] ...                     Subcommand arguments

Subcommands:
 info, show                    Show an external authentication source
 list, index                   List external authentication sources
 update                        Update organization and location for Auth Source

Options:
 -h, --help                    Print help

2.9.1.1. Hammer auth-source 外部信息

显示外部身份验证源

Usage:
    hammer auth-source external <info|show> [OPTIONS]

Options:
 --fields LIST                 Show specified fields or predefined field sets only. (See below)
 --id VALUE
 --location VALUE              Set the current location context for the request
 --location-id NUMBER          Set the current location context for the request
 --location-title VALUE        Set the current location context for the request
 --name VALUE                  Name to search by
 --organization VALUE          Set the current organization context for the request
 --organization-id NUMBER      Set the current organization context for the request
 --organization-title VALUE    Set the current organization context for the request
 -h, --help                    Print help

Predefined field sets:
  ---------------|-----|---------|-----
  FIELDS         | ALL | DEFAULT | THIN
  ---------------|-----|---------|-----
  Id             | x   | x       | x
  Name           | x   | x       | x
  Locations/     | x   | x       |
  Organizations/ | x   | x       |
  ---------------|-----|---------|-----

Option details:
  Here you can find option types and the value an option can accept:

  BOOLEAN             One of true/false, yes/no, 1/0
  DATETIME            Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format
  ENUM                Possible values are described in the option's description
  FILE                Path to a file
  KEY_VALUE_LIST      Comma-separated list of key=value.
                      JSON is acceptable and preferred way for such parameters
  LIST                Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
                      JSON is acceptable and preferred way for such parameters
  MULTIENUM           Any combination of possible values described in the option's description
  NUMBER              Numeric value. Integer
  SCHEMA              Comma separated list of values defined by a schema.
                      JSON is acceptable and preferred way for such parameters
  VALUE               Value described in the option's description. Mostly simple string

2.9.1.2. Hammer auth-source 外部列表

列出外部身份验证源

Usage:
    hammer auth-source external <list|index> [OPTIONS]

Options:
 --fields LIST                 Show specified fields or predefined field sets only. (See below)
 --location VALUE              Set the current location context for the request
 --location-id NUMBER          Scope by locations
 --location-title VALUE        Set the current location context for the request
 --order VALUE                 Sort and order by a searchable field, e.g. '<field> DESC'
 --organization VALUE          Set the current organization context for the request
 --organization-id NUMBER      Scope by organizations
 --organization-title VALUE    Set the current organization context for the request
 --page NUMBER                 Page number, starting at 1
 --per-page VALUE              Number of results per page to return, 'all' to return all results
 --search VALUE                Filter results
 -h, --help                    Print help

Predefined field sets:
  -------|-----|---------|-----
  FIELDS | ALL | DEFAULT | THIN
  -------|-----|---------|-----
  Id     | x   | x       | x
  Name   | x   | x       | x
  -------|-----|---------|-----

Option details:
  Here you can find option types and the value an option can accept:

  BOOLEAN             One of true/false, yes/no, 1/0
  DATETIME            Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format
  ENUM                Possible values are described in the option's description
  FILE                Path to a file
  KEY_VALUE_LIST      Comma-separated list of key=value.
                      JSON is acceptable and preferred way for such parameters
  LIST                Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
                      JSON is acceptable and preferred way for such parameters
  MULTIENUM           Any combination of possible values described in the option's description
  NUMBER              Numeric value. Integer
  SCHEMA              Comma separated list of values defined by a schema.
                      JSON is acceptable and preferred way for such parameters
  VALUE               Value described in the option's description. Mostly simple string

Search / Order fields:
  location            string
  location_id         integer
  name                string
  organization        string
  organization_id     integer

2.9.1.3. Hammer auth-source 外部更新

更新 Auth 源的机构和位置

Usage:
    hammer auth-source external update [OPTIONS]

Options:
 --id VALUE
 --location VALUE              Set the current location context for the request
 --location-id NUMBER          Set the current location context for the request
 --location-ids LIST           REPLACE locations with given ids
 --location-title VALUE        Set the current location context for the request
 --location-titles LIST
 --locations LIST
 --name VALUE
 --new-name VALUE
 --organization VALUE          Set the current organization context for the request
 --organization-id NUMBER      Set the current organization context for the request
 --organization-ids LIST       REPLACE organizations with given ids.
 --organization-title VALUE    Set the current organization context for the request
 --organization-titles LIST
 --organizations LIST
 -h, --help                    Print help

Option details:
  Here you can find option types and the value an option can accept:

  BOOLEAN             One of true/false, yes/no, 1/0
  DATETIME            Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format
  ENUM                Possible values are described in the option's description
  FILE                Path to a file
  KEY_VALUE_LIST      Comma-separated list of key=value.
                      JSON is acceptable and preferred way for such parameters
  LIST                Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
                      JSON is acceptable and preferred way for such parameters
  MULTIENUM           Any combination of possible values described in the option's description
  NUMBER              Numeric value. Integer
  SCHEMA              Comma separated list of values defined by a schema.
                      JSON is acceptable and preferred way for such parameters
  VALUE               Value described in the option's description. Mostly simple string

2.9.2. Hammer auth-source ldap

管理 LDAP 身份验证源

Usage:
    hammer auth-source ldap [OPTIONS] SUBCOMMAND [ARG] ...

Parameters:
 SUBCOMMAND                    Subcommand
 [ARG] ...                     Subcommand arguments

Subcommands:
 create                        Create an LDAP authentication source
 delete, destroy               Delete an LDAP authentication source
 info, show                    Show an LDAP authentication source
 list, index                   List all LDAP authentication sources
 update                        Update an LDAP authentication source

Options:
 -h, --help                    Print help

2.9.2.1. Hammer auth-source ldap 创建

创建 LDAP 身份验证源

Usage:
    hammer auth-source ldap create [OPTIONS]

Options:
 --account VALUE
 --account-password VALUE      Required if onthefly_register is true
 --attr-firstname VALUE        Required if onthefly_register is true
 --attr-lastname VALUE         Required if onthefly_register is true
 --attr-login VALUE            Required if onthefly_register is true
 --attr-mail VALUE             Required if onthefly_register is true
 --attr-photo VALUE
 --base-dn VALUE
 --groups-base VALUE           Groups base DN
 --host VALUE                  The hostname of the LDAP server
 --ldap-filter VALUE           LDAP filter
 --location VALUE              Set the current location context for the request
 --location-id NUMBER          Set the current location context for the request
 --location-ids LIST           REPLACE locations with given ids
 --location-title VALUE        Set the current location context for the request
 --location-titles LIST
 --locations LIST
 --name VALUE
 --onthefly-register BOOLEAN
 --organization VALUE          Set the current organization context for the request
 --organization-id NUMBER      Set the current organization context for the request
 --organization-ids LIST       REPLACE organizations with given ids.
 --organization-title VALUE    Set the current organization context for the request
 --organization-titles LIST
 --organizations LIST
 --port NUMBER                 Defaults to 389
 --server-type ENUM            Type of the LDAP server
                               Possible value(s): 'free_ipa', 'active_directory', 'posix'
 --tls BOOLEAN
 --use-netgroups BOOLEAN       Use NIS netgroups instead of posix groups, applicable only when server_type is
                               posix or free_ipa
 --usergroup-sync BOOLEAN      Sync external user groups on login
 -h, --help                    Print help

Option details:
  Here you can find option types and the value an option can accept:

  BOOLEAN             One of true/false, yes/no, 1/0
  DATETIME            Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format
  ENUM                Possible values are described in the option's description
  FILE                Path to a file
  KEY_VALUE_LIST      Comma-separated list of key=value.
                      JSON is acceptable and preferred way for such parameters
  LIST                Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
                      JSON is acceptable and preferred way for such parameters
  MULTIENUM           Any combination of possible values described in the option's description
  NUMBER              Numeric value. Integer
  SCHEMA              Comma separated list of values defined by a schema.
                      JSON is acceptable and preferred way for such parameters
  VALUE               Value described in the option's description. Mostly simple string

2.9.2.2. Hammer auth-source ldap delete

删除 LDAP 身份验证源

Usage:
    hammer auth-source ldap <delete|destroy> [OPTIONS]

Options:
 --id VALUE
 --location VALUE              Set the current location context for the request
 --location-id NUMBER          Set the current location context for the request
 --location-title VALUE        Set the current location context for the request
 --name VALUE                  Name to search by
 --organization VALUE          Set the current organization context for the request
 --organization-id NUMBER      Set the current organization context for the request
 --organization-title VALUE    Set the current organization context for the request
 -h, --help                    Print help

Option details:
  Here you can find option types and the value an option can accept:

  BOOLEAN             One of true/false, yes/no, 1/0
  DATETIME            Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format
  ENUM                Possible values are described in the option's description
  FILE                Path to a file
  KEY_VALUE_LIST      Comma-separated list of key=value.
                      JSON is acceptable and preferred way for such parameters
  LIST                Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
                      JSON is acceptable and preferred way for such parameters
  MULTIENUM           Any combination of possible values described in the option's description
  NUMBER              Numeric value. Integer
  SCHEMA              Comma separated list of values defined by a schema.
                      JSON is acceptable and preferred way for such parameters
  VALUE               Value described in the option's description. Mostly simple string

2.9.2.3. Hammer auth-source ldap 信息

显示 LDAP 身份验证源

Usage:
    hammer auth-source ldap <info|show> [OPTIONS]

Options:
 --fields LIST                 Show specified fields or predefined field sets only. (See below)
 --id VALUE
 --location VALUE              Set the current location context for the request
 --location-id NUMBER          Set the current location context for the request
 --location-title VALUE        Set the current location context for the request
 --name VALUE                  Name to search by
 --organization VALUE          Set the current organization context for the request
 --organization-id NUMBER      Set the current organization context for the request
 --organization-title VALUE    Set the current organization context for the request
 -h, --help                    Print help

Predefined field sets:
  -------------------------------------------|-----|--------
  FIELDS                                     | ALL | DEFAULT
  -------------------------------------------|-----|--------
  Server/id                                  | x   | x
  Server/name                                | x   | x
  Server/server                              | x   | x
  Server/ldaps                               | x   | x
  Server/port                                | x   | x
  Server/server type                         | x   | x
  Account/account username                   | x   | x
  Account/base dn                            | x   | x
  Account/groups base dn                     | x   | x
  Account/use netgroups                      | x   | x
  Account/ldap filter                        | x   | x
  Account/automatically create accounts?     | x   | x
  Account/usergroup sync                     | x   | x
  Attribute mappings/login name attribute    | x   | x
  Attribute mappings/first name attribute    | x   | x
  Attribute mappings/last name attribute     | x   | x
  Attribute mappings/email address attribute | x   | x
  Attribute mappings/photo attribute         | x   | x
  Locations/                                 | x   | x
  Organizations/                             | x   | x
  -------------------------------------------|-----|--------

Option details:
  Here you can find option types and the value an option can accept:

  BOOLEAN             One of true/false, yes/no, 1/0
  DATETIME            Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format
  ENUM                Possible values are described in the option's description
  FILE                Path to a file
  KEY_VALUE_LIST      Comma-separated list of key=value.
                      JSON is acceptable and preferred way for such parameters
  LIST                Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
                      JSON is acceptable and preferred way for such parameters
  MULTIENUM           Any combination of possible values described in the option's description
  NUMBER              Numeric value. Integer
  SCHEMA              Comma separated list of values defined by a schema.
                      JSON is acceptable and preferred way for such parameters
  VALUE               Value described in the option's description. Mostly simple string

2.9.2.4. Hammer auth-source ldap list

列出所有 LDAP 验证源

Usage:
    hammer auth-source ldap <list|index> [OPTIONS]

Options:
 --fields LIST                 Show specified fields or predefined field sets only. (See below)
 --location VALUE              Set the current location context for the request
 --location-id NUMBER          Scope by locations
 --location-title VALUE        Set the current location context for the request
 --order VALUE                 Sort and order by a searchable field, e.g. '<field> DESC'
 --organization VALUE          Set the current organization context for the request
 --organization-id NUMBER      Scope by organizations
 --organization-title VALUE    Set the current organization context for the request
 --page NUMBER                 Page number, starting at 1
 --per-page VALUE              Number of results per page to return, 'all' to return all results
 --search VALUE                Filter results
 -h, --help                    Print help

Predefined field sets:
  -------|-----|---------|-----
  FIELDS | ALL | DEFAULT | THIN
  -------|-----|---------|-----
  Id     | x   | x       | x
  Name   | x   | x       | x
  Server | x   | x       |
  Port   | x   | x       |
  Ldaps? | x   | x       |
  -------|-----|---------|-----

Option details:
  Here you can find option types and the value an option can accept:

  BOOLEAN             One of true/false, yes/no, 1/0
  DATETIME            Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format
  ENUM                Possible values are described in the option's description
  FILE                Path to a file
  KEY_VALUE_LIST      Comma-separated list of key=value.
                      JSON is acceptable and preferred way for such parameters
  LIST                Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
                      JSON is acceptable and preferred way for such parameters
  MULTIENUM           Any combination of possible values described in the option's description
  NUMBER              Numeric value. Integer
  SCHEMA              Comma separated list of values defined by a schema.
                      JSON is acceptable and preferred way for such parameters
  VALUE               Value described in the option's description. Mostly simple string

Search / Order fields:
  location            string
  location_id         integer
  name                string
  organization        string
  organization_id     integer

2.9.2.5. Hammer auth-source ldap 更新

更新 LDAP 身份验证源

Usage:
    hammer auth-source ldap update [OPTIONS]

Options:
 --account VALUE
 --account-password VALUE      Required if onthefly_register is true
 --attr-firstname VALUE        Required if onthefly_register is true
 --attr-lastname VALUE         Required if onthefly_register is true
 --attr-login VALUE            Required if onthefly_register is true
 --attr-mail VALUE             Required if onthefly_register is true
 --attr-photo VALUE
 --base-dn VALUE
 --groups-base VALUE           Groups base DN
 --host VALUE                  The hostname of the LDAP server
 --id VALUE
 --ldap-filter VALUE           LDAP filter
 --location VALUE              Set the current location context for the request
 --location-id NUMBER          Set the current location context for the request
 --location-ids LIST           REPLACE locations with given ids
 --location-title VALUE        Set the current location context for the request
 --location-titles LIST
 --locations LIST
 --name VALUE
 --new-name VALUE
 --onthefly-register BOOLEAN
 --organization VALUE          Set the current organization context for the request
 --organization-id NUMBER      Set the current organization context for the request
 --organization-ids LIST       REPLACE organizations with given ids.
 --organization-title VALUE    Set the current organization context for the request
 --organization-titles LIST
 --organizations LIST
 --port NUMBER                 Defaults to 389
 --server-type ENUM            Type of the LDAP server
                               Possible value(s): 'free_ipa', 'active_directory', 'posix'
 --tls BOOLEAN
 --use-netgroups BOOLEAN       Use NIS netgroups instead of posix groups, applicable only when server_type is
                               posix or free_ipa
 --usergroup-sync BOOLEAN      Sync external user groups on login
 -h, --help                    Print help

Option details:
  Here you can find option types and the value an option can accept:

  BOOLEAN             One of true/false, yes/no, 1/0
  DATETIME            Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format
  ENUM                Possible values are described in the option's description
  FILE                Path to a file
  KEY_VALUE_LIST      Comma-separated list of key=value.
                      JSON is acceptable and preferred way for such parameters
  LIST                Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
                      JSON is acceptable and preferred way for such parameters
  MULTIENUM           Any combination of possible values described in the option's description
  NUMBER              Numeric value. Integer
  SCHEMA              Comma separated list of values defined by a schema.
                      JSON is acceptable and preferred way for such parameters
  VALUE               Value described in the option's description. Mostly simple string

2.9.3. Hammer auth-source list

列出所有身份验证源

Usage:
    hammer auth-source <list|index> [OPTIONS]

Options:
 --fields LIST                 Show specified fields or predefined field sets only. (See below)
 --location VALUE              Set the current location context for the request
 --location-id NUMBER          Scope by locations
 --location-title VALUE        Set the current location context for the request
 --order VALUE                 Sort and order by a searchable field, e.g. '<field> DESC'
 --organization VALUE          Set the current organization context for the request
 --organization-id NUMBER      Scope by organizations
 --organization-title VALUE    Set the current organization context for the request
 --page NUMBER                 Page number, starting at 1
 --per-page VALUE              Number of results per page to return, 'all' to return all results
 --search VALUE                Filter results
 -h, --help                    Print help

Predefined field sets:
  --------------------|-----|---------|-----
  FIELDS              | ALL | DEFAULT | THIN
  --------------------|-----|---------|-----
  Id                  | x   | x       | x
  Name                | x   | x       | x
  Type of auth source | x   | x       |
  --------------------|-----|---------|-----

Option details:
  Here you can find option types and the value an option can accept:

  BOOLEAN             One of true/false, yes/no, 1/0
  DATETIME            Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format
  ENUM                Possible values are described in the option's description
  FILE                Path to a file
  KEY_VALUE_LIST      Comma-separated list of key=value.
                      JSON is acceptable and preferred way for such parameters
  LIST                Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
                      JSON is acceptable and preferred way for such parameters
  MULTIENUM           Any combination of possible values described in the option's description
  NUMBER              Numeric value. Integer
  SCHEMA              Comma separated list of values defined by a schema.
                      JSON is acceptable and preferred way for such parameters
  VALUE               Value described in the option's description. Mostly simple string

Search / Order fields:
  location            string
  location_id         integer
  name                string
  organization        string
  organization_id     integer