freeipa/doc/api/netgroup_find.md
Antonio Torres 988cb5a535 doc: generate API Reference
Extend the 'make api' target so that we also build an API Reference in
Markdown format. One template for each command gets generated. These
templates include all of the command details (arguments, options and
outputs), and then a section for manually-added notes such as semantics
or version differences. Every time the docs are regenerated, these notes
will be added if they exist.

Signed-off-by: Antonio Torres <antorres@redhat.com>
Reviewed-By: Alexander Bokovoy <abokovoy@redhat.com>
Reviewed-By: Rob Crittenden <rcritten@redhat.com>
2022-11-16 14:46:17 -05:00

1.5 KiB

netgroup_find

Search for a netgroup.

Arguments

Name Type Required
criteria :ref:Str<Str> False

Options

  • private : :ref:Flag<Flag> (Required)
  • Default: False
  • managed : :ref:Flag<Flag> (Required)
  • Default: False
  • all : :ref:Flag<Flag> (Required)
  • Default: False
  • raw : :ref:Flag<Flag> (Required)
  • Default: False
  • no_members : :ref:Flag<Flag> (Required)
  • Default: True
  • cn : :ref:Str<Str>
  • description : :ref:Str<Str>
  • nisdomainname : :ref:Str<Str>
  • ipauniqueid : :ref:Str<Str>
  • usercategory : :ref:StrEnum<StrEnum>
  • Values: ('all',)
  • hostcategory : :ref:StrEnum<StrEnum>
  • Values: ('all',)
  • externalhost : :ref:Str<Str>
  • timelimit : :ref:Int<Int>
  • sizelimit : :ref:Int<Int>
  • version : :ref:Str<Str>
  • pkey_only : :ref:Flag<Flag>
  • Default: False
  • netgroup : :ref:Str<Str>
  • no_netgroup : :ref:Str<Str>
  • user : :ref:Str<Str>
  • no_user : :ref:Str<Str>
  • group : :ref:Str<Str>
  • no_group : :ref:Str<Str>
  • host : :ref:Str<Str>
  • no_host : :ref:Str<Str>
  • hostgroup : :ref:Str<Str>
  • no_hostgroup : :ref:Str<Str>
  • in_netgroup : :ref:Str<Str>
  • not_in_netgroup : :ref:Str<Str>

Output

Name Type
count Output
result ListOfEntries
summary Output
truncated Output

Semantics

Notes

Version differences