action vmware_list_recommended_rules {
  label: "Get logical recommended rules"
  description: "Get recommended firewall rules based on the flow data gathered by vRealize Network Insight.\nThis API provides service to retrieve recommended rules based on flow traffic that is observed between\ntwo groups OR for a single group based on all the inbound and outboud traffic for that group.\nIn case two groups are provided, both the groups should be of same type.\nCurrently supported groups are Application, Tier, NSXSecurityGroup, EC2SecurityGroup."
  provider: vmware
  method: POST
  path: "/micro-seg/recommended-rules"
  encoding: json
  input: {
    type: "object"
    properties: {
      group_1: {
        type: "object"
        properties: {
          entity: {
            type: "object"
            properties: {
              entity_id: {
                type: "string"
              }
              entity_type: {
                type: "string"
                enum: ["VirtualMachine", "EC2Instance", "Host", "Vnic", "Vmknic", "VxlanLayer2Network", "VlanL2Network", "Cluster", "SecurityTag", "ResourcePool", "NSXIPSet", "EC2IPSet", "NSXSecurityGroup", "EC2SecurityGroup", "Flow", "ProblemEvent", "Application", "Tier", "NSXFirewallRule", "EC2SGFirewallRule", "NSXRedirectRule", "VCenterManager", "NSXVManager", "NSXService", "EC2Service", "VPC", "NSXDistributedFirewall", "EC2Firewall", "NSXServiceGroup", "DistributedVirtualSwitch", "DistributedVirtualPortgroup", "VCDatacenter", "Datastore", "Folder"]
              }
            }
          }
        }
      }
      group_2: {
        type: "object"
        additionalProperties: true
      }
      time_range: {
        type: "object"
        properties: {
          end_time: {
            type: "integer"
            format: "int64"
          }
          start_time: {
            type: "integer"
            format: "int64"
          }
        }
      }
    }
  }
  output: {
    type: "object"
    properties: {
      results: {
        type: "array"
        items: {
          type: "object"
          properties: {
            action: {
              type: "string"
              enum: ["ALLOW", "DROP"]
            }
            destinations: {
              type: "array"
              items: {
                type: "object"
                properties: {
                  entity_id: {
                    type: "string"
                  }
                  entity_type: {
                    type: "string"
                    enum: ["VirtualMachine", "EC2Instance", "Host", "Vnic", "Vmknic", "VxlanLayer2Network", "VlanL2Network", "Cluster", "SecurityTag", "ResourcePool", "NSXIPSet", "EC2IPSet", "NSXSecurityGroup", "EC2SecurityGroup", "Flow", "ProblemEvent", "Application", "Tier", "NSXFirewallRule", "EC2SGFirewallRule", "NSXRedirectRule", "VCenterManager", "NSXVManager", "NSXService", "EC2Service", "VPC", "NSXDistributedFirewall", "EC2Firewall", "NSXServiceGroup", "DistributedVirtualSwitch", "DistributedVirtualPortgroup", "VCDatacenter", "Datastore", "Folder"]
                  }
                }
              }
            }
            port_ranges: {
              type: "array"
              items: {
                type: "object"
                properties: {
                  end: {
                    type: "integer"
                    format: "int32"
                  }
                  start: {
                    type: "integer"
                    format: "int32"
                  }
                }
              }
            }
            protocols: {
              type: "array"
              items: {
                type: "string"
              }
            }
            sources: {
              type: "array"
              items: {
                type: "object"
                additionalProperties: true
              }
            }
          }
        }
      }
      time_range: {
        type: "object"
        properties: {
          end_time: {
            type: "integer"
            format: "int64"
          }
          start_time: {
            type: "integer"
            format: "int64"
          }
        }
      }
    }
  }
}