blacklist ip list:
  help: List item(-s) in IP Black List
  cli:
    users:
      - root
  type: dict
  schema:
    by_ip:
      type: string
      nullable: true

    by_country_code:
      type: string
      nullable: true

    by_comment:
      type: string
      nullable: true
      empty: false

    manual:
      type: boolean
      nullable: true

    limit:
      type: integer
      coerce: int
      default: 50
    offset:
      type: integer
      coerce: int
      default: 0

blacklist ip delete:
  help: Remove item(-s) from IP Black List
  return_type: NoItemsAgentResponse
  cli:
    users:
      - root
  type: dict
  schema:
    items:
      type: list
      schema:
        type: ip
        coerce: ip
        check_with:
          - enforce64min_subnet_mask_for_ipv6
      required: true
      positional: true

blacklist ip add:
  help: Add item(-s) to IP Black List
  return_type: NoItemsAgentResponse
  cli:
    users:
      - root
  type: dict
  schema:
    items:
      type: list
      schema:
        type: ip
        coerce: ip
        check_with:
          - enforce64min_subnet_mask_for_ipv6
      required: true
      positional: true
    comment:
      type: string
    expiration:
      help: allows specifying expiration time for the listed IP (in seconds since epoch)
      type: integer
      default: 0
      check_with:
        - expiration
      coerce: int
    scope:
      type: string
      default: local
      allowed:
        - local
        - group
    client_addr:
      type: ip
      nullable: true
      default: null

blacklist ip move:
  help: Move item(-s) to IP Black List
  return_type: NoItemsAgentResponse
  cli:
    users:
      - root
  type: dict
  schema:
    items:
      type: list
      schema:
        type: ip
        coerce: ip
        check_with:
          - enforce64min_subnet_mask_for_ipv6
      required: true
      positional: true

blacklist ip edit:
  help: Edit comment on item in the IP Black List
  return_type: NoItemsAgentResponse
  cli:
    users:
      - root
  type: dict
  schema:
    items:
      type: list
      schema:
        type: ip
        coerce: ip
        check_with:
          - enforce64min_subnet_mask_for_ipv6
      required: true
      positional: true
    comment:
      type: string
    expiration:
      help: allows specifying expiration time for the listed IP (in seconds since epoch)
      type: integer
      coerce: int
      check_with:
        - expiration
    scope:
      type: string
      allowed:
        - local
        - group