Update FBAD Config

Update FBAD Config

Update the flow based configuration used for application and tier discovery. All the fields in the request JSON are optional and default configuration will be used for undefined fields. The order of discovery options will be honoured during application discovery if discovery options are defined in the input request. Please use API api/ni/groups/discovered-applications/custom-config/fbad/file/upload to upload a CSV file to be used for application and tier discovery and naming. Use the filepath in it's response in the values tag of discovery options and naming preferences, each of type CSV, as applicable.

Request
URI
PUT
https://www.mgmt.cloud.vmware.com/ni/api/ni/groups/discovered-applications/custom-config/fbad/{id}
COPY
Path Parameters
string
id
Required

The Entity ID of object requestion information on


Request Body
FBADConfigRequest of type(s) application/json
Required
{
    "scope_object_type": 66,
    "scope_entities": [
        "Cluster-3",
        "Haas-cluster-adhoc",
        "HaaS-Cluster-6",
        "HaaS-Regression-Cluster-7",
        "HaaS-Cluster-2"
    ],
    "full_fetch_flow_interval_in_sec": 604800,
    "pause_discovery": false,
    "application_naming_preferences": [
        {
            "type": "LB_VIRTUAL_SERVERS"
        },
        {
            "type": "NSX_SECURITY_GROUPS"
        },
        {
            "type": "SECURITY_TAGS"
        },
        {
            "type": "VCENTER_TAGS",
            "values": [
                "AppSystem",
                "App Sys",
                "App_ownership"
            ]
        },
        {
            "type": "VM_NAMES",
            "values": [
                ".*?_([^-_@. ]*)-([^-_@. ]*)-.*"
            ]
        }
    ],
    "tier_naming_preferences": [
        {
            "type": "LB_VIRTUAL_SERVERS"
        },
        {
            "type": "NSX_SECURITY_GROUPS"
        },
        {
            "type": "SECURITY_TAGS"
        },
        {
            "type": "VCENTER_TAGS",
            "values": [
                "TestDB",
                "TestDB2",
                "Space"
            ]
        },
        {
            "type": "VM_NAMES",
            "values": [
                ".*?_([^-_@. ]*)-.*"
            ]
        }
    ],
    "discovery_options": [
        {
            "type": "CSV",
            "value": "RkJBRF9URU1QX0ZJTEU6OklZTU9zQzd1NnQ5S0lEY0xybXRYRVEuY3N2"
        },
        {
            "type": "LB"
        }
    ]
}
integer As int32 As int32
scope_object_type
Optional

The type of objects in the scope entities

array of string
scope_entities
Optional

The list of name of the entities to be considered in discovery scope

integer As int64 As int64
full_fetch_flow_interval_in_sec
Optional

Full fetch flow interval in seconds. Range of allowed values is number of seconds in one week to number of seconds in one month, both values included.

boolean
pause_discovery
Optional

True means pause the application and tier discovery and false means resume flow based application and tier discovery

application_naming_preferences
Optional

List of application naming preferences. The order should be the same as tier naming preferences. VM Names preference will be added to the end of the naming preferences if not present already.

tier_naming_preferences
Optional

List of tier naming preferences. The order should be the same as application naming preferences. VM Names preference will be added to the end of the naming preferences if not present already.

discovery_options
Optional

The ordered list of preferences to be used for discovery of applications and tiers to improve flow based application discovery. Add CSV enrichment preference to use the uploaded CSV in improving discovery. LB enrichment preference will be added at the end of the list if not present already.

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns FBADConfigResponse of type(s) application/json
This response body class contains all of the following: FBADConfigRequest
{
    "id": "16710:969:5155421418804951043",
    "scope_object_type": 66,
    "scope_entities": [
        "Cluster-3",
        "Haas-cluster-adhoc",
        "HaaS-Cluster-6",
        "HaaS-Regression-Cluster-7",
        "HaaS-Cluster-2"
    ],
    "full_fetch_flow_interval_in_sec": 604800,
    "pause_discovery": false,
    "application_naming_preferences": [
        {
            "type": "LB_VIRTUAL_SERVERS"
        },
        {
            "type": "NSX_SECURITY_GROUPS"
        },
        {
            "type": "SECURITY_TAGS"
        },
        {
            "type": "VCENTER_TAGS",
            "values": [
                "AppSystem",
                "App Sys",
                "App_ownership"
            ]
        },
        {
            "type": "VM_NAMES",
            "values": [
                ".*?_([^-_@. ]*)-([^-_@. ]*)-.*"
            ]
        }
    ],
    "tier_naming_preferences": [
        {
            "type": "LB_VIRTUAL_SERVERS"
        },
        {
            "type": "NSX_SECURITY_GROUPS"
        },
        {
            "type": "SECURITY_TAGS"
        },
        {
            "type": "VCENTER_TAGS",
            "values": [
                "TestDB",
                "TestDB2",
                "Space"
            ]
        },
        {
            "type": "VM_NAMES",
            "values": [
                ".*?_([^-_@. ]*)-.*"
            ]
        }
    ],
    "discovery_options": [
        {
            "type": "CSV",
            "value": "RkJBRF9QRVJNOjpuYW1pbmdfcHJlZmVyZW5jZXNfMTAwMDBfOTY5Xzg3NzE5NDEyMzYyNTk3MTY3NDBfMTY4NjY1OTY0ODQxNC5jc3Y="
        },
        {
            "type": "LB"
        }
    ]
}

400

Bad Request

Returns ApiError of type(s) application/json
{
    "code": 0,
    "message": "string",
    "details": [
        {
            "code": 0,
            "message": "string",
            "target": [
                "string"
            ]
        }
    ]
}
integer As int32 As int32
code
Optional

code

string
message
Optional

message

details
Optional

details


401

Unauthorized

Operation doesn't return any data structure

500

Internal Error

Operation doesn't return any data structure