Adding an HTTP receiver for metadata streaming using the CLI

Prev Next

Follow these steps to add an HTTP receiver for metadata streaming of Email Security - Server appliance email events:

To add an HTTP metadata receiver using the CLI:

  1. Go to CLI configuration mode.

    hostname > enable
    hostname # configure terminal
  2. Enable metadata streaming on the appliance.

    hostname (config) # datastreaming configuration enable
  3. Enable metadata streaming for the HTTP receiver.

    hostname (config) # datastreaming configuration protocol http enable
  4. Specify the name of the HTTP receiver to receive the metadata streaming events.

    hostname (config) # datastreaming configuraton protocol http consumers <service-name>
  5. Enable the HTTP receiver to receive the metadata streaming events.

    hostname (config) # datastreaming configuraton protocol http consumers <service-name> enable
  6. Specify the IPv4 address or hostname of the HTTP server to send metadata streaming events to:

    hostname (config) # datastreaming configuration protocol http consumers <service-name> server-url <url>

    Note

    IPv6 addresses are not supported.

  7. (Optional) If authentication is required for the server, enable authentication and configure either a token or basic method.

    hostname (config) # datastreaming configuration protocol http consumers <service-name> auth enable 
    hostname (config) # datastreaming configuration protocol http consumers <service-name> auth method {TOKEN | BASIC} 
  8. (Optional) Enter a software token if you are using a token authentication method.

    hostname (config) # datastreaming configuration protocol http consumers <service-name> auth token <token>
  9. (Optional) Enter a user name if you are using a basic authentication method.

    hostname (config) # datastreaming configuration protocol http consumers <service-name> auth username <username>
  10. (Optional) Enter a password if you are using a basic authentication method.

    hostname (config) # datastreaming configuration protocol http consumers <service-name> auth password <password>
  11. (Optional) Specify the content type that is to be streamed to the HTTP receiver.

    hostname (config) # datastreaming configuration protocol http consumers <service-name> content-type {application/json | application/x-www-form-urlencoded | text/plain}
  12. (Optional) Enable SSL verification on the HTTP receiver.

    hostname (config) # datastreaming configuration protocol http consumers <service-name> ssl verify enable
  13. (Optional) Enable SSL TLS communications over the metadata stream to the HTTP receiver.

    hostname (config) # datastreaming configuration protocol http consumers <service-name> ssl tls enable 
  14. (Optional) Specify the minimum version of the TLS protocol to secure metadata streaming on the HTTP receiver.

    hostname (config) # datastreaming configuration protocol http consumers <service-name>  ssl min-version {TLSv1 | TLSv1.1 | TLSv1.2}
  15. (Optional) Specify the list of supplemental certificates of authority (CA) that is to be used for the HTTP receiver.

    hostname (config) # datastreaming configuration protocol http consumers <service-name>  ssl ca-list {none | default-ca-list}
  16. Verify the changes.

    hostname (config) # show datastreaming configuration
    
    data-streaming configuration:
       Feature enabled                  :    yes
       HTTP enabled                     :    yes
       Rsyslog enabled                  :    yes
    
       Helix Configuration:
       Helix enabled                    :    no
       Helix FQDN                       :
       Helix bootstrap certificate      :
    
       Subscribed http consumers        :    1
    
       Subscriber 01 of type: http:
       name                     =    HTTP_Receiver_Milpitas
       enable                   =    yes
       server-url               =    
    https://milpitas.fireeye.com:8443/receiver.jsp
       content-type             =    text/plain
       collector-type           =    ********
       Authorization:
       auth enable              =    yes
       method                   =    BASIC
       token                    =    
       username                 =    admin
       auth password            =    xxxxxxx
       SSL:
       verify                   =    yes
       min version              =    TLSv1.2
       ssl supplemental CA list =    none
       TLS                      =    yes  
        
       hostname (config) #
      
  17. Save the changes to the current active configuration.

    hostname (config) # write memory