#
# (c) 2017, Forcepoint
# Documentation fragment. This fragment specifies the top level
# requirements for obtaining a valid session to the Forcepoint NGFW Management
# Center. 

class ModuleDocFragment(object):
    # Standard documentation fragment
    DOCUMENTATION = '''
options:
  filter:
    description:
      - String value to match against when making query. Matches all if not specified.
        A filter will attempt to find a match in the name, primary key field or comment
        field of a given record.
    required: false
    default: '*'
    type: str
  limit:
    description:
      - Limit the number of results. Set to 0 to remove limit.
    required: false
    default: 10
    type: int
  exact_match:
    description:
      - Whether to do an exact match on the filter specified
    required: false
    default: false
  case_sensitive:
    description:
      - Whether to do a case sensitive match on the filter specified
    required: false
    default: true

notes:
  - If a filter is not used in the query, this will return all results for the
    element type specified. The return data in this case will only contain the metadata
    for the element which will be name and type. To get detailed information about an
    element, use a filter. When using filters on network or service elements, the filter
    value will search the element fields, for example, you could use a filter of '1.1.1.1'
    when searching for hosts and all hosts with this IP will be returned. The same applies
    for services. If you are unsure of the service name but know the port you require, your
    filter can be by port.
'''
