> ## Documentation Index
> Fetch the complete documentation index at: https://docs.aviatrix.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Groups

> This section provides the purpose, elements, and actions performed on the Groups pages.

This section provides the purpose, elements, and actions performed on the
**Groups** pages.

<Tabs>
  <Tab title="SmartGroups">
    ## Purpose

    The **SmartGroups** page displays and manages SmartGroups, which are dynamic
    collections of resources that can be used for filtering, policy configuration,
    and network management across the Aviatrix CoPilot platform.

    ## Elements

    <Frame>
      <img
        src={
  "/images/reference/ui/groups/smartgroups-overview.png"
}
        alt="Groups: SmartGroups"
        width="100%"
      />
    </Frame>

    * **SmartGroups table**: Shows a list of all configured SmartGroups with their
      details.
    * **+ SmartGroup button**: Button to create a new SmartGroup.
    * **Refetch CSP Resources button**: Button to refresh cloud service provider
      resources.
    * **Show filters button**: Button to show or hide filter options.
    * **Export button**: Button to export SmartGroups data.
    * **Search box**: Search box for filtering SmartGroups in the table.
    * **Refresh button**: Button to refresh the SmartGroups table data.

    ## Actions

    <AccordionGroup>
      <Accordion title="View SmartGroups">
        To view SmartGroups:

        1. Go to **Groups** > **SmartGroups**.
        2. The SmartGroups page appears with the SmartGroups table listing all configured SmartGroups.
        3. Optionally, use **Search** or **Show filters** to filter the table.
        4. Optionally, click **Export** to export SmartGroups data or **Refresh** to refresh the table.

        The table shows Name, Resource Type, and Rule References for each SmartGroup.

        ### Parameter Details

        | CoPilot Parameter Name | Description                                                                                                         |
        | ---------------------- | ------------------------------------------------------------------------------------------------------------------- |
        | Name                   | Shows the name of the SmartGroup.                                                                                   |
        | Resource Type          | Shows the resource type of the SmartGroup (e.g., VPC/VNets, External Connections (S2C), Kubernetes Workloads, VMs). |
        | Rule References        | Shows the number of rules that reference this SmartGroup.                                                           |
      </Accordion>

      <Accordion title="Create SmartGroup">
        To create a new SmartGroup:

        1. Go to **Groups** > **SmartGroups**.
        2. Click **+ SmartGroup**.
        3. Enter a unique **Name** for the SmartGroup.
        4. Select **Resource Type** (e.g., VPC/VNets, External Connections (S2C), Kubernetes Workloads, VMs, Subnets).
        5. Define **Match Conditions** (e.g., tags, labels, attributes). Optionally, filter by **Cloud**, **Region**, or **Account**.
        6. Use **Preview** to see the number of resources that match the criteria.
        7. Save the SmartGroup.

        The new SmartGroup appears in the SmartGroups table.

        ### Parameter Details

        | CoPilot Parameter Name | Description                                                                                                 |
        | ---------------------- | ----------------------------------------------------------------------------------------------------------- |
        | Name                   | Enter a unique name for the SmartGroup.                                                                     |
        | Resource Type          | Select the resource type (VPC/VNets, External Connections (S2C), Kubernetes Workloads, VMs, Subnets, etc.). |
        | Match Conditions       | Define the criteria for matching resources (e.g., tags, labels, attributes, cloud, region, account).        |
        | Cloud                  | Select the cloud provider to filter resources (optional).                                                   |
        | Region                 | Select the cloud region to filter resources (optional).                                                     |
        | Account                | Select the cloud account to filter resources (optional).                                                    |
        | Preview                | Shows the number of resources that match the defined criteria.                                              |
      </Accordion>

      <Accordion title="Edit SmartGroup">
        To edit a SmartGroup:

        1. Go to **Groups** > **SmartGroups**.
        2. Locate and select the SmartGroup in the table.<br />Optionally, use **Search** or **Show filters** to find it.
        3. Click the **Edit** icon near the SmartGroup name.
        4. Update the SmartGroup fields as needed.
        5. Click **Save**.

        A notification appears confirming the changes to the SmartGroup.
      </Accordion>

      <Accordion title="Delete SmartGroup">
        To delete a SmartGroup:

        1. Go to **Groups** > **SmartGroups**.
        2. Locate and select the SmartGroup in the table.<br />Optionally, use **Search** or **Show filters** to find it.
        3. Click the **Delete** icon near the SmartGroup name.
        4. Click **Delete** to confirm.

        A notification appears confirming the deletion of the SmartGroup.
      </Accordion>

      <Accordion title="Refetch CSP Resources">
        To refresh cloud service provider resources for SmartGroups:

        1. Go to **Groups** > **SmartGroups**.
        2. Click **Refetch CSP Resources**.

        CSP resources are refreshed so SmartGroup membership reflects current cloud
        state.
      </Accordion>
    </AccordionGroup>
  </Tab>

  <Tab title="ExternalGroups">
    ## Purpose

    The **ExternalGroups** page displays and manages External Groups, which are
    collections of external resources or connections that can be used for policy
    configuration and network management.

    ## Elements

    <Frame>
      <img
        src={
  "/images/reference/ui/groups/externalgroups-overview.png"
}
        alt="Groups: ExternalGroups"
        width="100%"
      />
    </Frame>

    * **ExternalGroups table**: Shows a list of all configured External Groups with
      their details.
    * **+ ExternalGroup button**: Button to create a new External Group.
    * **Show filters button**: Button to show or hide filter options.
    * **Export button**: Button to export External Groups data.
    * **Search box**: Search box for filtering External Groups in the table.
    * **Refresh button**: Button to refresh the External Groups table data.

    ## Actions

    <AccordionGroup>
      <Accordion title="View External Groups">
        To view External Groups:

        1. Go to **Groups** > **ExternalGroups**.
        2. The ExternalGroups page appears with the ExternalGroups table listing all configured External Groups.
        3. Optionally, use **Search** or **Show filters** to filter the table.
        4. Optionally, click **Export** to export data or **Refresh** to refresh the table.

        The table shows Name, Type, Rule References, Status, and Last Updated for each
        External Group.

        ### Parameter Details

        | CoPilot Parameter Name | Description                                                    |
        | ---------------------- | -------------------------------------------------------------- |
        | Name                   | Shows the name of the External Group.                          |
        | Type                   | Shows the type of External Group.                              |
        | Rule References        | Shows the number of rules that reference this External Group.  |
        | Status                 | Shows the current status of the External Group.                |
        | Last Updated           | Shows the timestamp when the External Group was last modified. |
      </Accordion>

      <Accordion title="Create External Group">
        To create a new External Group:

        1. Go to **Groups** > **ExternalGroups**.
        2. Click **+ ExternalGroup**.
        3. Configure the External Group (name, type, and associated resources).
        4. Save the External Group.

        The new External Group appears in the ExternalGroups table.
      </Accordion>
    </AccordionGroup>
  </Tab>

  <Tab title="WebGroups">
    ## Purpose

    The **WebGroups** page displays and manages Web Groups, which are collections of
    web-based resources, domains, or URLs that can be used for firewall policies and
    security configurations.

    ## Elements

    <Frame>
      <img
        src={
  "/images/reference/ui/groups/webgroups-overview.png"
}
        alt="Groups: WebGroups"
        width="100%"
      />
    </Frame>

    * **WebGroups table**: Shows a list of all configured Web Groups with their
      details.
    * **+ WebGroup button**: Button to create a new Web Group.
    * **Show filters button**: Button to show or hide filter options.
    * **Select columns button**: Button to choose which columns to display in the
      table.
    * **Export button**: Button to export Web Groups data.
    * **Search box**: Search box for filtering Web Groups in the table.
    * **View selector**: Drop-down to switch between saved table views.
    * **Refresh button**: Button to refresh the Web Groups table data.

    ## Actions

    <AccordionGroup>
      <Accordion title="View Web Groups">
        To view Web Groups:

        1. Go to **Groups** > **WebGroups**.
        2. The WebGroups page appears with the WebGroups table listing all configured Web Groups.
        3. Optionally, use **Search** or **Show filters** to filter the table.
        4. Optionally, click **Select columns** to customize the displayed columns.
        5. Optionally, click **Export** to export data or **Refresh** to refresh the table.

        The table shows Name, Type, Domains/URLs, and Rule References for each Web
        Group.

        ### Parameter Details

        | CoPilot Parameter Name | Description                                                                                                                     |
        | ---------------------- | ------------------------------------------------------------------------------------------------------------------------------- |
        | Name                   | Shows the name of the Web Group.                                                                                                |
        | Type                   | Shows whether the Web Group filters by `Domains` or `URLs`. The built-in `All-Web` Web Group is shown as `Predefined WebGroup`. |
        | Domains/URLs           | Shows the domains or URLs included in the Web Group.                                                                            |
        | Rule References        | Shows the number of Distributed Cloud Firewall rules that reference this Web Group.                                             |
      </Accordion>

      <Accordion title="Create Web Group">
        To create a new Web Group:

        1. Go to **Groups** > **WebGroups**.
        2. Click **+ WebGroup**.
        3. Configure the following fields:

        | Field   | Description                                                                                                      |
        | ------- | ---------------------------------------------------------------------------------------------------------------- |
        | Name    | Enter a name for the Web Group.                                                                                  |
        | Type    | Select **Domains** or **URLs**. A single Web Group can match by domains or by URLs, but not both.                |
        | Domains | (Type = Domains) Enter one or more domains, for example `google.com`, `www.microsoft.com`, or `*.amazonaws.com`. |
        | URLs    | (Type = URLs) Enter one or more URLs, for example `github.com/AviatrixFieldEng/`.                                |

        4. Click **Save**.

        The new Web Group appears in the WebGroups table.
      </Accordion>

      <Accordion title="Edit a Web Group">
        To edit a Web Group:

        1. Go to **Groups** > **WebGroups**.
        2. In the row for the Web Group you want to change, click the **Edit** action.
        3. In the **Edit WebGroup: \<name>** dialog, update the **Name**, **Type**, or
           **Domains**/**URLs** fields.
        4. Click **Save**.

        The predefined `All-Web` Web Group cannot be edited.
      </Accordion>

      <Accordion title="Delete a Web Group">
        To delete a Web Group:

        1. Go to **Groups** > **WebGroups**.
        2. In the row for the Web Group you want to remove, click the **Delete** action.
        3. Confirm the deletion.

        A Web Group that is referenced by one or more Distributed Cloud Firewall rules
        cannot be deleted; remove the rule references first. The predefined `All-Web`
        Web Group cannot be deleted.
      </Accordion>
    </AccordionGroup>
  </Tab>

  <Tab title="Feeds">
    ## Purpose

    The **Feeds** page displays and manages Feeds, which are data sources or
    information feeds that can be used for policy updates, threat intelligence, or
    dynamic resource management.

    ## Elements

    <Frame>
      <img src={"/images/reference/ui/groups/feeds-overview.png"} alt="Groups: Feeds" width="100%" />
    </Frame>

    * **Feeds table**: Shows a list of all configured Feeds with their details.
    * **+ Feed button**: Button to create a new Feed.
    * **Show filters button**: Button to show or hide filter options.
    * **Export button**: Button to export Feeds data.
    * **Search box**: Search box for filtering Feeds in the table.
    * **Refresh button**: Button to refresh the Feeds table data.

    ## Actions

    <AccordionGroup>
      <Accordion title="View Feeds">
        To view Feeds:

        1. Go to **Groups** > **Feeds**.
        2. The Feeds page appears with the Feeds table listing all configured Feeds.
        3. Optionally, use **Search** or **Show filters** to filter the table.
        4. Optionally, click **Export** to export data or **Refresh** to refresh the table.

        The table shows Name, Type, Source, Status, Last Updated, and Last Sync for each
        Feed.

        ### Parameter Details

        | CoPilot Parameter Name | Description                                                               |
        | ---------------------- | ------------------------------------------------------------------------- |
        | Name                   | Shows the name of the Feed.                                               |
        | Type                   | Shows the type of Feed (e.g., Threat Intelligence, IP List, Domain List). |
        | Source                 | Shows the source URL or location of the Feed.                             |
        | Status                 | Shows the current status of the Feed (e.g., Active, Inactive, Error).     |
        | Last Updated           | Shows the timestamp when the Feed was last updated.                       |
        | Last Sync              | Shows the timestamp when the Feed was last synchronized.                  |
      </Accordion>

      <Accordion title="Create Feed">
        To create a new Feed:

        1. Go to **Groups** > **Feeds**.
        2. Click **+ Feed**.
        3. Configure the Feed (name, type, source URL, and other settings).
        4. Save the Feed.

        The new Feed appears in the Feeds table.
      </Accordion>
    </AccordionGroup>
  </Tab>

  <Tab title="Settings">
    ## Purpose

    The **Settings** page displays configuration options and settings for Groups
    management, including default behaviors, refresh intervals, and group-related
    preferences.

    ## Elements

    <Frame>
      <img
        src={
  "/images/reference/ui/groups/groups-settings.png"
}
        alt="Groups: Settings"
        width="100%"
      />
    </Frame>

    * **Settings sections**: Configuration cards for various Groups settings.
    * **Save button**: Button to save the settings changes.
    * **Reset button**: Button to reset settings to default values.

    ## Actions

    <AccordionGroup>
      <Accordion title="Configure Groups Settings">
        To configure Groups management settings:

        1. Go to **Groups** > **Settings**.
        2. The Settings page appears with configuration cards for Groups settings.
        3. Configure **Auto-refresh Interval**, **Default Group Type**, **Resource Sync Settings**, **Validation Rules**, or **Notification Settings** as needed.
        4. Click **Save** to apply changes or **Reset** to restore default values.

        Settings are applied after you save.

        ### Parameter Details

        | CoPilot Parameter Name | Description                                                   |
        | ---------------------- | ------------------------------------------------------------- |
        | Auto-refresh Interval  | Sets the automatic refresh interval for Groups data.          |
        | Default Group Type     | Sets the default type for new groups.                         |
        | Resource Sync Settings | Configures how resources are synchronized for SmartGroups.    |
        | Validation Rules       | Defines validation rules for group creation and modification. |
        | Notification Settings  | Configures notifications for group-related events.            |
      </Accordion>
    </AccordionGroup>
  </Tab>
</Tabs>
