> ## 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.

# Egress

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

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

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

    The **Overview** page shows the Egress Security Score, protected VPC/VNets
    status, and provides access to manage VPC/VNets configuration.

    ## Elements

    <Frame>
      <img
        src={
  "/images/reference/ui/security/egress-overview.png"
}
        alt="Egress: Overview"
        width="100%"
      />
    </Frame>

    * **Egress Security Score**: Information card showing egress security score with
      gauge visualization.
    * **How Is Egress Score Calculated?**: Information card with illustration and
      description about egress score calculation.
    * **Protected VPC/VNets**: Information card showing breakdown of protected
      VPC/VNets by status.
    * **Progress indicators**: Progress bars showing metrics.
    * **Manage VPC/VNets button**: Button to navigate to the Egress VPC/VNets page.
    * **Learn More button**: Button to access additional information about egress
      score calculation.

    ## Actions

    <AccordionGroup>
      <Accordion title="View Egress Overview">
        To view the egress security overview:

        1. Go to **Security** > **Egress** > **Overview**.
        2. The Overview page appears with the Egress Security Score, Protected VPC/VNets status, and progress indicators.
        3. Review the egress security score and protected VPC/VNet breakdown.
        4. Optionally, click **Learn More** to access additional information about egress score calculation.

        The Overview provides a summary of egress security posture across your
        environment.

        ### Parameter Details

        | CoPilot Parameter Name | Description                                                                                     |
        | ---------------------- | ----------------------------------------------------------------------------------------------- |
        | Egress Security Score  | Shows the overall egress security score with gauge visualization.                               |
        | Protected VPC/VNets    | Shows the breakdown of protected VPC/VNets by status (e.g., Protected, Unprotected, Monitored). |
        | Progress indicators    | Progress bars showing metrics related to egress security.                                       |
      </Accordion>

      <Accordion title="Manage VPC/VNets">
        To navigate to the Egress VPC/VNets page:

        1. Go to **Security** > **Egress** > **Overview**.
        2. Click **Manage VPC/VNets**.

        The Egress VPC/VNets page opens where you can manage VPC/VNet egress
        configuration.
      </Accordion>
    </AccordionGroup>
  </Tab>

  <Tab title="Analyze">
    ## Purpose

    The **Analyze** page provides analysis of egress traffic patterns, top rules
    hit, top domains, top source IPs, and egress per VPC/VNet.

    ## Elements

    <Frame>
      <img
        src={
  "/images/reference/ui/security/egress-analyze.png"
}
        alt="Egress: Analyze"
        width="100%"
      />
    </Frame>

    * **Time Period**: Dropdown to select time period for analysis.
    * **Start**: Date and time picker field for start time.
    * **End**: Date and time picker field for end time.
    * **Top Rules Hit**: Analysis section showing top rules hit.
    * **Top Domains**: Analysis section showing top domains.
    * **Top Source IPs**: Analysis section showing top source IPs.
    * **Egress Per VPC/VNet**: Analysis section showing egress per VPC/VNet.
    * **Refresh Data button**: Button to refresh the analysis data.

    ## Actions

    <AccordionGroup>
      <Accordion title="View Egress Analysis">
        To view egress traffic analysis:

        1. Go to **Security** > **Egress** > **Analyze**.
        2. The Analyze page appears with Top Rules Hit, Top Domains, Top Source IPs, and Egress Per VPC/VNet sections.
        3. Optionally, use the **Time Period** dropdown or **Start** and **End** fields to select a time range for analysis.
        4. Click **Refresh Data** to refresh the analysis data.

        The analysis helps identify egress traffic patterns and top consumers for
        security review.

        ### Parameter Details

        | CoPilot Parameter Name | Description                                          |
        | ---------------------- | ---------------------------------------------------- |
        | Time Period            | Dropdown to select time period for analysis.         |
        | Start                  | Date and time picker field for start time.           |
        | End                    | Date and time picker field for end time.             |
        | Top Rules Hit          | Shows the top rules hit in egress traffic analysis.  |
        | Top Domains            | Shows the top domains accessed in egress traffic.    |
        | Top Source IPs         | Shows the top source IP addresses in egress traffic. |
        | Egress Per VPC/VNet    | Shows egress traffic analysis per VPC/VNet.          |
      </Accordion>
    </AccordionGroup>
  </Tab>

  <Tab title="Egress VPC/VNets">
    ## Purpose

    The **Egress VPC/VNets** page shows a table of VPC/VNets with their egress
    configuration status, point of egress, and recommended actions.

    ## Elements

    <Frame>
      <img
        src={
  "/images/reference/ui/security/egress-vpc-vnets.png"
}
        alt="Egress: Egress VPC/VNets"
        width="100%"
      />
    </Frame>

    * **Search**: Search box for filtering table content.
    * **Default View**: Dropdown to select default view.
    * **Filter button**: Button to show filters.
    * **Columns button**: Button to select columns.
    * **Download button**: Button to export data.
    * **Show filters button**: Button to display filter options.
    * **Select columns button**: Button to customize visible columns.
    * **Export button**: Button to export table data.
    * **Deploy Gateway button**: Button to deploy gateway for selected VPC/VNet.

    ## Actions

    <AccordionGroup>
      <Accordion title="View Egress VPC/VNets">
        To view VPC/VNet egress configuration:

        1. Go to **Security** > **Egress** > **Egress VPC/VNets**.
        2. The Egress VPC/VNets page appears with the table of VPC/VNets and their egress status.
        3. Optionally, use **Search**, **Filter**, **Default View**, or **Columns** to customize the view.
        4. Optionally, click **Download** or **Export** to export table data.

        The table shows egress configuration status, point of egress, and recommended
        actions for each VPC/VNet.

        ### Parameter Details

        | CoPilot Parameter Name | Description                                                                            |
        | ---------------------- | -------------------------------------------------------------------------------------- |
        | Name                   | Shows the VPC/VNet name and management status.                                         |
        | Spoke Gateway          | Shows the Spoke Gateway associated with the VPC/VNet.                                  |
        | Point of Egress        | Shows the point of egress configuration (e.g., Native Cloud Egress).                   |
        | Transit Attachment     | Shows the Transit Gateway attachment information.                                      |
        | Cloud                  | Shows the cloud provider where the VPC/VNet is located.                                |
        | Region                 | Shows the cloud region where the VPC/VNet is located.                                  |
        | IP CIDRs               | Shows the IP CIDR blocks for the VPC/VNet.                                             |
        | Status                 | Shows the protection status of the VPC/VNet (e.g., Unprotected, Protected, Monitored). |
        | Recommended Action     | Shows the recommended action for the VPC/VNet (e.g., Deploy Gateway).                  |
      </Accordion>

      <Accordion title="Deploy Gateway for VPC/VNet">
        To deploy a gateway for a selected VPC/VNet:

        1. Go to **Security** > **Egress** > **Egress VPC/VNets**.
        2. Locate the VPC/VNet in the table and select it.
        3. Click **Deploy Gateway**.

        The gateway deployment workflow starts for the selected VPC/VNet.
      </Accordion>
    </AccordionGroup>
  </Tab>

  <Tab title="Transit Egress">
    ## Purpose

    The **Transit Egress** page shows Transit Gateways configured for egress control
    and allows enabling egress on Transit Gateways.

    ## Elements

    <Frame>
      <img
        src={
  "/images/reference/ui/security/egress-transit-egress.png"
}
        alt="Egress: Transit Egress"
        width="100%"
      />
    </Frame>

    * **Enable Egress on Transit button**: Opens the dialog to enable egress on a
      Transit Gateway.
    * **Filter button**: Button to show filters.
    * **Columns button**: Button to select columns.
    * **Download button**: Button to export table data.
    * **Search**: Search box for filtering the Transit Gateway list.
    * **Transit Egress table**: Displays Transit Gateways configured for egress with
      Type, Cloud, Region, VPC/VNet, Cloud Load Balancer, Firewalls, Inspection, and
      Egress status.

    ## Actions

    <AccordionGroup>
      <Accordion title="View Transit Egress">
        To view Transit Gateways configured for egress control:

        1. Go to **Security** > **Egress** > **Transit Egress**.
        2. The Transit Egress page appears with the table of Transit Gateways and their egress configuration.
        3. Optionally, use **Search**, **Filter**, or **Columns** to customize the view.
        4. Optionally, click **Download** to export table data.

        The table shows Transit Gateway egress status, inspection settings, and
        associated resources.

        ### Parameter Details

        | CoPilot Parameter Name | Description                                                                |
        | ---------------------- | -------------------------------------------------------------------------- |
        | Transit Gateway        | Displays the Transit Gateway configured for egress.                        |
        | Type                   | Displays the gateway type associated with the transit egress setup.        |
        | Cloud                  | Indicates the cloud provider where the Transit Gateway runs.               |
        | Region                 | Displays the cloud region of the Transit Gateway.                          |
        | VPC/VNet               | Displays the VPC or VNet attached to the Transit Gateway.                  |
        | Cloud Load Balancer    | Indicates whether a cloud load balancer is associated with egress traffic. |
        | Firewalls              | Displays the firewall resources used for egress traffic inspection.        |
        | Inspection             | Indicates whether traffic inspection is enabled.                           |
        | Egress                 | Displays the egress status for the Transit Gateway.                        |
      </Accordion>

      <Accordion title="Enable Egress on Transit Gateway">
        To enable egress on a Transit Gateway:

        1. Go to **Security** > **Egress** > **Transit Egress**.
        2. Click **Enable Egress on Transit**.
        3. In the dialog, select the **Transit Gateway** on which to enable egress.
        4. Choose **Primary Egress** or **Secondary Egress** and configure **Attach Secondary Egress(s)** if applicable.
        5. In **Launch & Associate Egress Instance(s)**, configure **Egress Instance Size**, **Attach to Subnet**, and add instances with **+ Egress Instance** as needed.
        6. Click **Enable** to apply the configuration.

        Egress is enabled on the selected Transit Gateway. Use **Cancel** to discard
        changes and close the dialog.

        ### Parameter Details

        | CoPilot Parameter Name                | Description                                                                                           |
        | ------------------------------------- | ----------------------------------------------------------------------------------------------------- |
        | Transit Gateway                       | Selects the Transit Gateway on which egress is enabled.                                               |
        | Primary Egress                        | Enables the selected Transit Gateway to provide egress control for attached Spoke Gateways.           |
        | Secondary Egress                      | Allows the Transit Gateway to forward traffic to a Primary Transit Egress Gateway for egress control. |
        | Attach Secondary Egress(s)            | Selects one or more Secondary Transit Gateways to associate with the Primary Egress Gateway.          |
        | Launch & Associate Egress Instance(s) | Section to create and associate egress instances with the Transit Gateway.                            |
        | Egress Instance Size                  | Selects the instance size for the egress virtual machine.                                             |
        | + Egress Instance                     | Adds a new egress instance configuration entry.                                                       |
        | Attach to Subnet                      | Selects the subnet where the egress instance is deployed.                                             |
        | Cancel                                | Discards the configuration changes and closes the dialog.                                             |
        | Enable                                | Applies the configuration and enables egress on the selected Transit Gateway.                         |
      </Accordion>
    </AccordionGroup>
  </Tab>

  <Tab title="FQDN Monitor (Legacy)">
    ## Purpose

    The **FQDN Monitor (Legacy)** page shows FQDN monitoring data for selected
    VPC/VNets, including timestamp, source IP, domain, port, rule match, and action
    information.

    ## Elements

    <Frame>
      <img
        src={
  "/images/reference/ui/security/egress-fqdn-monitor-legacy.png"
}
        alt="Egress: FQDN Monitor (Legacy)"
        width="100%"
      />
    </Frame>

    * **Filters**: Collapsible filters section.
    * **Time Period**: Dropdown to select time period.
    * **Start**: Date and time picker field for start time.
    * **End**: Date and time picker field for end time.
    * **VPC/VNets**: Combobox to select VPC/VNets to monitor.
    * **Search**: Search box (unavailable/disabled).
    * **Show filters button**: Button to display filter options.
    * **Select columns button**: Button to customize visible columns.
    * **Export button**: Button to export table data.

    ## Actions

    <AccordionGroup>
      <Accordion title="View FQDN Monitor Data">
        To view FQDN monitoring data:

        1. Go to **Security** > **Egress** > **FQDN Monitor (Legacy)**.
        2. The FQDN Monitor page appears with the monitoring table.
        3. Use **Time Period** or **Start** and **End** fields to select a time range.
        4. Use **VPC/VNets** combobox to select VPC/VNets to monitor.
        5. Optionally, use **Filters**, **Select columns**, or **Export** to customize or export data.

        The table displays FQDN monitoring events with timestamp, source IP, domain,
        port, rule match, and action.

        ### Parameter Details

        | CoPilot Parameter Name | Description                                           |
        | ---------------------- | ----------------------------------------------------- |
        | Timestamp              | Shows the timestamp of the FQDN monitoring event.     |
        | Source IP              | Shows the source IP address of the egress traffic.    |
        | VPC/VNet               | Shows the VPC/VNet where the traffic originated.      |
        | Domain                 | Shows the domain name accessed in the egress traffic. |
        | Port                   | Shows the port number used for the egress traffic.    |
        | Rule Match             | Shows whether the traffic matched a rule.             |
        | Action                 | Shows the action taken for the egress traffic.        |
      </Accordion>
    </AccordionGroup>
  </Tab>
</Tabs>
