group.get_group_obj
===================

Returns dictionary containing information from struct grp for the group specified by either the `groupname` or `gid`.

If `sid_info` is specified then addition SMB / domain information is returned for the group.

.. raw:: html

    <div id="json-schema"> <span class="badge badge-dark value-type">Type: object</span><br/> <div class="accordion" id="accordionCall_parameters"> <div class="card"> <div class="card-header" id="headingCall_parameters"> <h2 class="mb-0"> <button aria-controls="Call_parameters" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters" data-toggle="collapse" onclick="setAnchor('#Call_parameters')" type="button"><span class="property-name">Call parameters</span></button> </h2> </div> <div aria-labelledby="headingCall_parameters" class="collapse property-definition-div" data-parent="#accordionCall_parameters" id="Call_parameters"> <div class="card-body pl-5"> <span class="badge badge-dark value-type">Type: array</span><br/> <span class="badge badge-info no-additional">No Additional Items</span><h4>Tuple Validation</h4> <h5>Parameter 1: get_group_obj</h5> <div class="card"> <div class="card-body items-definition" id="Call_parameters_items_i0"> <h4>get_group_obj</h4><span class="badge badge-dark value-type">Type: object</span><br/> <span class="badge badge-info no-additional">No Additional Properties</span> <div class="accordion" id="accordionCall_parameters_items_i0_groupname"> <div class="card"> <div class="card-header" id="headingCall_parameters_items_i0_groupname"> <h2 class="mb-0"> <button aria-controls="Call_parameters_items_i0_groupname" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_groupname" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_groupname')" type="button"><span class="property-name">groupname</span></button> </h2> </div> <div aria-labelledby="headingCall_parameters_items_i0_groupname" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_groupname" id="Call_parameters_items_i0_groupname"> <div class="card-body pl-5"> <h4>Groupname</h4> <span class="badge badge-success default-value">Default: null</span><br/> <div class="any-of-value" id="Call_parameters_items_i0_groupname_anyOf"><h2 class="handle"> <label>Any of</label> </h2><ul class="nav nav-tabs" id="tabsCall_parameters_items_i0_groupname_anyOf_anyOf" role="tablist"><li class="nav-item"> <a class="nav-link active anyOf-option" data-toggle="tab" href="#tab-pane_Call_parameters_items_i0_groupname_anyOf_i0" id="Call_parameters_items_i0_groupname_anyOf_i0" onclick="setAnchor('#Call_parameters_items_i0_groupname_anyOf_i0')" role="tab">Option 1</a> </li><li class="nav-item"> <a class="nav-link anyOf-option" data-toggle="tab" href="#tab-pane_Call_parameters_items_i0_groupname_anyOf_i1" id="Call_parameters_items_i0_groupname_anyOf_i1" onclick="setAnchor('#Call_parameters_items_i0_groupname_anyOf_i1')" role="tab">Option 2</a> </li></ul> <div class="tab-content card"><div class="tab-pane fade card-body active show" id="tab-pane_Call_parameters_items_i0_groupname_anyOf_i0" role="tabpanel"> <span class="badge badge-dark value-type">Type: string</span><br/> </div><div class="tab-pane fade card-body" id="tab-pane_Call_parameters_items_i0_groupname_anyOf_i1" role="tabpanel"> <span class="badge badge-dark value-type">Type: null</span><br/> </div></div></div> </div> </div> </div> </div> <div class="accordion" id="accordionCall_parameters_items_i0_gid"> <div class="card"> <div class="card-header" id="headingCall_parameters_items_i0_gid"> <h2 class="mb-0"> <button aria-controls="Call_parameters_items_i0_gid" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_gid" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_gid')" type="button"><span class="property-name">gid</span></button> </h2> </div> <div aria-labelledby="headingCall_parameters_items_i0_gid" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_gid" id="Call_parameters_items_i0_gid"> <div class="card-body pl-5"> <h4>Gid</h4> <span class="badge badge-success default-value">Default: null</span><br/> <div class="any-of-value" id="Call_parameters_items_i0_gid_anyOf"><h2 class="handle"> <label>Any of</label> </h2><ul class="nav nav-tabs" id="tabsCall_parameters_items_i0_gid_anyOf_anyOf" role="tablist"><li class="nav-item"> <a class="nav-link active anyOf-option" data-toggle="tab" href="#tab-pane_Call_parameters_items_i0_gid_anyOf_i0" id="Call_parameters_items_i0_gid_anyOf_i0" onclick="setAnchor('#Call_parameters_items_i0_gid_anyOf_i0')" role="tab">Option 1</a> </li><li class="nav-item"> <a class="nav-link anyOf-option" data-toggle="tab" href="#tab-pane_Call_parameters_items_i0_gid_anyOf_i1" id="Call_parameters_items_i0_gid_anyOf_i1" onclick="setAnchor('#Call_parameters_items_i0_gid_anyOf_i1')" role="tab">Option 2</a> </li></ul> <div class="tab-content card"><div class="tab-pane fade card-body active show" id="tab-pane_Call_parameters_items_i0_gid_anyOf_i0" role="tabpanel"> <span class="badge badge-dark value-type">Type: integer</span><br/> </div><div class="tab-pane fade card-body" id="tab-pane_Call_parameters_items_i0_gid_anyOf_i1" role="tabpanel"> <span class="badge badge-dark value-type">Type: null</span><br/> </div></div></div> </div> </div> </div> </div> <div class="accordion" id="accordionCall_parameters_items_i0_sid_info"> <div class="card"> <div class="card-header" id="headingCall_parameters_items_i0_sid_info"> <h2 class="mb-0"> <button aria-controls="Call_parameters_items_i0_sid_info" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_sid_info" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_sid_info')" type="button"><span class="property-name">sid_info</span></button> </h2> </div> <div aria-labelledby="headingCall_parameters_items_i0_sid_info" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_sid_info" id="Call_parameters_items_i0_sid_info"> <div class="card-body pl-5"> <h4>Sid Info</h4><span class="badge badge-dark value-type">Type: boolean</span> <span class="badge badge-success default-value">Default: false</span><br/> </div> </div> </div> </div> </div> </div> </div> </div> </div> </div> <div class="accordion" id="accordionReturn_value"> <div class="card"> <div class="card-header" id="headingReturn_value"> <h2 class="mb-0"> <button aria-controls="Return_value" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value" data-toggle="collapse" onclick="setAnchor('#Return_value')" type="button"><span class="property-name">Return value</span></button> </h2> </div> <div aria-labelledby="headingReturn_value" class="collapse property-definition-div" data-parent="#accordionReturn_value" id="Return_value"> <div class="card-body pl-5"> <h4>GroupGetGroupObjResult</h4><span class="badge badge-dark value-type">Type: object</span><br/> <span class="badge badge-info no-additional">No Additional Properties</span> <div class="accordion" id="accordionReturn_value_gr_name"> <div class="card"> <div class="card-header" id="headingReturn_value_gr_name"> <h2 class="mb-0"> <button aria-controls="Return_value_gr_name" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_gr_name" data-toggle="collapse" onclick="setAnchor('#Return_value_gr_name')" type="button"><span class="property-name">gr_name</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_gr_name" class="collapse property-definition-div" data-parent="#accordionReturn_value_gr_name" id="Return_value_gr_name"> <div class="card-body pl-5"> <h4>Gr Name</h4><span class="badge badge-dark value-type">Type: string</span><br/> <span class="description"><p>Name of the group.</p> </span> </div> </div> </div> </div> <div class="accordion" id="accordionReturn_value_gr_gid"> <div class="card"> <div class="card-header" id="headingReturn_value_gr_gid"> <h2 class="mb-0"> <button aria-controls="Return_value_gr_gid" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_gr_gid" data-toggle="collapse" onclick="setAnchor('#Return_value_gr_gid')" type="button"><span class="property-name">gr_gid</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_gr_gid" class="collapse property-definition-div" data-parent="#accordionReturn_value_gr_gid" id="Return_value_gr_gid"> <div class="card-body pl-5"> <h4>Gr Gid</h4><span class="badge badge-dark value-type">Type: integer</span><br/> <span class="description"><p>Group ID of the group.</p> </span> </div> </div> </div> </div> <div class="accordion" id="accordionReturn_value_gr_mem"> <div class="card"> <div class="card-header" id="headingReturn_value_gr_mem"> <h2 class="mb-0"> <button aria-controls="Return_value_gr_mem" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_gr_mem" data-toggle="collapse" onclick="setAnchor('#Return_value_gr_mem')" type="button"><span class="property-name">gr_mem</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_gr_mem" class="collapse property-definition-div" data-parent="#accordionReturn_value_gr_mem" id="Return_value_gr_mem"> <div class="card-body pl-5"> <h4>Gr Mem</h4><span class="badge badge-dark value-type">Type: array of string</span><br/> <span class="description"><p>List of group names that are members of the group.</p> </span> <span class="badge badge-info no-additional">No Additional Items</span><h5>Each item of this array must be:</h5> <div class="card"> <div class="card-body items-definition" id="Return_value_gr_mem_items"> <span class="badge badge-dark value-type">Type: string</span><br/> </div> </div> </div> </div> </div> </div> <div class="accordion" id="accordionReturn_value_sid"> <div class="card"> <div class="card-header" id="headingReturn_value_sid"> <h2 class="mb-0"> <button aria-controls="Return_value_sid" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_sid" data-toggle="collapse" onclick="setAnchor('#Return_value_sid')" type="button"><span class="property-name">sid</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_sid" class="collapse property-definition-div" data-parent="#accordionReturn_value_sid" id="Return_value_sid"> <div class="card-body pl-5"> <h4>Sid</h4> <span class="badge badge-success default-value">Default: null</span><br/> <span class="description"><p>Optional SID value for the account that is present if <code>sid_info</code> is specified in payload.</p> </span><div class="any-of-value" id="Return_value_sid_anyOf"><h2 class="handle"> <label>Any of</label> </h2><ul class="nav nav-tabs" id="tabsReturn_value_sid_anyOf_anyOf" role="tablist"><li class="nav-item"> <a class="nav-link active anyOf-option" data-toggle="tab" href="#tab-pane_Return_value_sid_anyOf_i0" id="Return_value_sid_anyOf_i0" onclick="setAnchor('#Return_value_sid_anyOf_i0')" role="tab">Option 1</a> </li><li class="nav-item"> <a class="nav-link anyOf-option" data-toggle="tab" href="#tab-pane_Return_value_sid_anyOf_i1" id="Return_value_sid_anyOf_i1" onclick="setAnchor('#Return_value_sid_anyOf_i1')" role="tab">Option 2</a> </li></ul> <div class="tab-content card"><div class="tab-pane fade card-body active show" id="tab-pane_Return_value_sid_anyOf_i0" role="tabpanel"> <span class="badge badge-dark value-type">Type: string</span><br/> </div><div class="tab-pane fade card-body" id="tab-pane_Return_value_sid_anyOf_i1" role="tabpanel"> <span class="badge badge-dark value-type">Type: null</span><br/> </div></div></div> </div> </div> </div> </div> <div class="accordion" id="accordionReturn_value_source"> <div class="card"> <div class="card-header" id="headingReturn_value_source"> <h2 class="mb-0"> <button aria-controls="Return_value_source" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_source" data-toggle="collapse" onclick="setAnchor('#Return_value_source')" type="button"><span class="property-name">source</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_source" class="collapse property-definition-div" data-parent="#accordionReturn_value_source" id="Return_value_source"> <div class="card-body pl-5"> <h4>Source</h4><span class="badge badge-dark value-type">Type: enum (of string)</span><br/> <span class="description"><p>The name server switch module that provided the user. Options are:<br/> FILES - local user in passwd file of server,<br/> WINBIND - user provided by winbindd,<br/> SSS - user provided by SSSD.</p> </span><div class="enum-value" id="Return_value_source_enum"> <h5>Must be one of:</h5> <ul class="list-group"><li class="list-group-item enum-item">"LOCAL"</li><li class="list-group-item enum-item">"ACTIVEDIRECTORY"</li><li class="list-group-item enum-item">"LDAP"</li></ul> </div> </div> </div> </div> </div> <div class="accordion" id="accordionReturn_value_local"> <div class="card"> <div class="card-header" id="headingReturn_value_local"> <h2 class="mb-0"> <button aria-controls="Return_value_local" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_local" data-toggle="collapse" onclick="setAnchor('#Return_value_local')" type="button"><span class="property-name">local</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_local" class="collapse property-definition-div" data-parent="#accordionReturn_value_local" id="Return_value_local"> <div class="card-body pl-5"> <h4>Local</h4><span class="badge badge-dark value-type">Type: boolean</span><br/> <span class="description"><p>Boolean indicating whether this group is local to the NAS or provided by a directory service.</p> </span> </div> </div> </div> </div> </div> </div> </div> </div> </div><br><br>

*Required roles:* ACCOUNT_READ