vcenter trusted infrastructure trust authority clusters kms providers: info

The info structure contains fields that describe the current configuration of a provider. This structure was added in vSphere API 7.0.0.

Representation:

{
    "key_server"{
        "proxy_server"{
            "hostname""string",
            "port"1
        },
        "description""string",
        "kmip_server"{
            "servers"[
                {
                    "address"{
                        "hostname""string",
                        "port"1
                    },
                    "name""string"
                },
                {
                    "address"{
                        "hostname""string",
                        "port"1
                    },
                    "name""string"
                }
            ],
            "username""string"
        },
        "type""KMIP",
        "connection_timeout"1
    },
    "master_key_id""string",
    "status"{
        "servers"[
            {
                "client_trust_server"true,
                "server_trust_client"true,
                "name""string",
                "health""NONE",
                "details"[
                    {
                        "args"[
                            "string",
                            "string"
                        ],
                        "default_message""string",
                        "localized""string",
                        "id""string",
                        "params"{
                            "<string>"{
                                "dt""2015-01-01T22:13:05.651Z",
                                "s""string",
                                "d"1.5,
                                "precision"1,
                                "format""SHORT_DATE",
                                "i"1,
                                "l"{
                                    "id""string",
                                    "params"{
                                        "<string>"{
                                            "dt""2015-01-01T22:13:05.651Z",
                                            "s""string",
                                            "d"1.5,
                                            "precision"1,
                                            "format""SHORT_DATE",
                                            "i"1,
                                            "l"{
                                                "id""string",
                                                "params"{}
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    },
                    {
                        "args"[
                            "string",
                            "string"
                        ],
                        "default_message""string",
                        "localized""string",
                        "id""string",
                        "params"{
                            "<string>"{
                                "dt""2015-01-01T22:13:05.651Z",
                                "s""string",
                                "d"1.5,
                                "precision"1,
                                "format""SHORT_DATE",
                                "i"1,
                                "l"{
                                    "id""string",
                                    "params"{
                                        "<string>"{
                                            "dt""2015-01-01T22:13:05.651Z",
                                            "s""string",
                                            "d"1.5,
                                            "precision"1,
                                            "format""SHORT_DATE",
                                            "i"1,
                                            "l"{
                                                "id""string",
                                                "params"{}
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    }
                ]
            },
            {
                "client_trust_server"true,
                "server_trust_client"true,
                "name""string",
                "health""NONE",
                "details"[
                    {
                        "args"[
                            "string",
                            "string"
                        ],
                        "default_message""string",
                        "localized""string",
                        "id""string",
                        "params"{
                            "<string>"{
                                "dt""2015-01-01T22:13:05.651Z",
                                "s""string",
                                "d"1.5,
                                "precision"1,
                                "format""SHORT_DATE",
                                "i"1,
                                "l"{
                                    "id""string",
                                    "params"{
                                        "<string>"{
                                            "dt""2015-01-01T22:13:05.651Z",
                                            "s""string",
                                            "d"1.5,
                                            "precision"1,
                                            "format""SHORT_DATE",
                                            "i"1,
                                            "l"{
                                                "id""string",
                                                "params"{}
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    },
                    {
                        "args"[
                            "string",
                            "string"
                        ],
                        "default_message""string",
                        "localized""string",
                        "id""string",
                        "params"{
                            "<string>"{
                                "dt""2015-01-01T22:13:05.651Z",
                                "s""string",
                                "d"1.5,
                                "precision"1,
                                "format""SHORT_DATE",
                                "i"1,
                                "l"{
                                    "id""string",
                                    "params"{
                                        "<string>"{
                                            "dt""2015-01-01T22:13:05.651Z",
                                            "s""string",
                                            "d"1.5,
                                            "precision"1,
                                            "format""SHORT_DATE",
                                            "i"1,
                                            "l"{
                                                "id""string",
                                                "params"{}
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    }
                ]
            }
        ],
        "health""NONE",
        "details"[
            {
                "args"[
                    "string",
                    "string"
                ],
                "default_message""string",
                "localized""string",
                "id""string",
                "params"{
                    "<string>"{
                        "dt""2015-01-01T22:13:05.651Z",
                        "s""string",
                        "d"1.5,
                        "precision"1,
                        "format""SHORT_DATE",
                        "i"1,
                        "l"{
                            "id""string",
                            "params"{
                                "<string>"{
                                    "dt""2015-01-01T22:13:05.651Z",
                                    "s""string",
                                    "d"1.5,
                                    "precision"1,
                                    "format""SHORT_DATE",
                                    "i"1,
                                    "l"{
                                        "id""string",
                                        "params"{}
                                    }
                                }
                            }
                        }
                    }
                }
            },
            {
                "args"[
                    "string",
                    "string"
                ],
                "default_message""string",
                "localized""string",
                "id""string",
                "params"{
                    "<string>"{
                        "dt""2015-01-01T22:13:05.651Z",
                        "s""string",
                        "d"1.5,
                        "precision"1,
                        "format""SHORT_DATE",
                        "i"1,
                        "l"{
                            "id""string",
                            "params"{
                                "<string>"{
                                    "dt""2015-01-01T22:13:05.651Z",
                                    "s""string",
                                    "d"1.5,
                                    "precision"1,
                                    "format""SHORT_DATE",
                                    "i"1,
                                    "l"{
                                        "id""string",
                                        "params"{}
                                    }
                                }
                            }
                        }
                    }
                }
            }
        ]
    }
}
{
    "key_server"{
        "proxy_server"{
            "hostname""string",
            "port"1
        },
        "description""string",
        "kmip_server"{
            "servers"[
                {
                    "address"{
                        "hostname""string",
                        "port"1
                    },
                    "name""string"
                },
                {
                    "address"{
                        "hostname""string",
                        "port"1
                    },
                    "name""string"
                }
            ],
            "username""string"
        },
        "type""KMIP",
        "connection_timeout"1
    },
    "master_key_id""string",
    "status"{
        "servers"[
            {
                "client_trust_server"true,
                "server_trust_client"true,
                "name""string",
                "health""NONE",
                "details"[
                    {
                        "args"[
                            "string",
                            "string"
                        ],
                        "default_message""string",
                        "localized""string",
                        "id""string",
                        "params"[
                            {
                                "value"{
                                    "dt""2015-01-01T22:13:05.651Z",
                                    "s""string",
                                    "d"1.5,
                                    "precision"1,
                                    "format""SHORT_DATE",
                                    "i"1,
                                    "l"{
                                        "id""string",
                                        "params"[
                                            {
                                                "value"{
                                                    "dt""2015-01-01T22:13:05.651Z",
                                                    "s""string",
                                                    "d"1.5,
                                                    "precision"1,
                                                    "format""SHORT_DATE",
                                                    "i"1,
                                                    "l"{
                                                        "id""string",
                                                        "params"[
                                                            {
                                                                "key""string"
                                                            }
                                                        ]
                                                    }
                                                },
                                                "key""string"
                                            }
                                        ]
                                    }
                                },
                                "key""string"
                            }
                        ]
                    },
                    {
                        "args"[
                            "string",
                            "string"
                        ],
                        "default_message""string",
                        "localized""string",
                        "id""string",
                        "params"[
                            {
                                "value"{
                                    "dt""2015-01-01T22:13:05.651Z",
                                    "s""string",
                                    "d"1.5,
                                    "precision"1,
                                    "format""SHORT_DATE",
                                    "i"1,
                                    "l"{
                                        "id""string",
                                        "params"[
                                            {
                                                "value"{
                                                    "dt""2015-01-01T22:13:05.651Z",
                                                    "s""string",
                                                    "d"1.5,
                                                    "precision"1,
                                                    "format""SHORT_DATE",
                                                    "i"1,
                                                    "l"{
                                                        "id""string",
                                                        "params"[
                                                            {
                                                                "key""string"
                                                            }
                                                        ]
                                                    }
                                                },
                                                "key""string"
                                            }
                                        ]
                                    }
                                },
                                "key""string"
                            }
                        ]
                    }
                ]
            },
            {
                "client_trust_server"true,
                "server_trust_client"true,
                "name""string",
                "health""NONE",
                "details"[
                    {
                        "args"[
                            "string",
                            "string"
                        ],
                        "default_message""string",
                        "localized""string",
                        "id""string",
                        "params"[
                            {
                                "value"{
                                    "dt""2015-01-01T22:13:05.651Z",
                                    "s""string",
                                    "d"1.5,
                                    "precision"1,
                                    "format""SHORT_DATE",
                                    "i"1,
                                    "l"{
                                        "id""string",
                                        "params"[
                                            {
                                                "value"{
                                                    "dt""2015-01-01T22:13:05.651Z",
                                                    "s""string",
                                                    "d"1.5,
                                                    "precision"1,
                                                    "format""SHORT_DATE",
                                                    "i"1,
                                                    "l"{
                                                        "id""string",
                                                        "params"[
                                                            {
                                                                "key""string"
                                                            }
                                                        ]
                                                    }
                                                },
                                                "key""string"
                                            }
                                        ]
                                    }
                                },
                                "key""string"
                            }
                        ]
                    },
                    {
                        "args"[
                            "string",
                            "string"
                        ],
                        "default_message""string",
                        "localized""string",
                        "id""string",
                        "params"[
                            {
                                "value"{
                                    "dt""2015-01-01T22:13:05.651Z",
                                    "s""string",
                                    "d"1.5,
                                    "precision"1,
                                    "format""SHORT_DATE",
                                    "i"1,
                                    "l"{
                                        "id""string",
                                        "params"[
                                            {
                                                "value"{
                                                    "dt""2015-01-01T22:13:05.651Z",
                                                    "s""string",
                                                    "d"1.5,
                                                    "precision"1,
                                                    "format""SHORT_DATE",
                                                    "i"1,
                                                    "l"{
                                                        "id""string",
                                                        "params"[
                                                            {
                                                                "key""string"
                                                            }
                                                        ]
                                                    }
                                                },
                                                "key""string"
                                            }
                                        ]
                                    }
                                },
                                "key""string"
                            }
                        ]
                    }
                ]
            }
        ],
        "health""NONE",
        "details"[
            {
                "args"[
                    "string",
                    "string"
                ],
                "default_message""string",
                "localized""string",
                "id""string",
                "params"[
                    {
                        "value"{
                            "dt""2015-01-01T22:13:05.651Z",
                            "s""string",
                            "d"1.5,
                            "precision"1,
                            "format""SHORT_DATE",
                            "i"1,
                            "l"{
                                "id""string",
                                "params"[
                                    {
                                        "value"{
                                            "dt""2015-01-01T22:13:05.651Z",
                                            "s""string",
                                            "d"1.5,
                                            "precision"1,
                                            "format""SHORT_DATE",
                                            "i"1,
                                            "l"{
                                                "id""string",
                                                "params"[
                                                    {
                                                        "key""string"
                                                    }
                                                ]
                                            }
                                        },
                                        "key""string"
                                    }
                                ]
                            }
                        },
                        "key""string"
                    }
                ]
            },
            {
                "args"[
                    "string",
                    "string"
                ],
                "default_message""string",
                "localized""string",
                "id""string",
                "params"[
                    {
                        "value"{
                            "dt""2015-01-01T22:13:05.651Z",
                            "s""string",
                            "d"1.5,
                            "precision"1,
                            "format""SHORT_DATE",
                            "i"1,
                            "l"{
                                "id""string",
                                "params"[
                                    {
                                        "value"{
                                            "dt""2015-01-01T22:13:05.651Z",
                                            "s""string",
                                            "d"1.5,
                                            "precision"1,
                                            "format""SHORT_DATE",
                                            "i"1,
                                            "l"{
                                                "id""string",
                                                "params"[
                                                    {
                                                        "key""string"
                                                    }
                                                ]
                                            }
                                        },
                                        "key""string"
                                    }
                                ]
                            }
                        },
                        "key""string"
                    }
                ]
            }
        ]
    }
}

Attributes:

Name Type Description
Required
-.master_key_id string Master key identifier created for the provider.

A unique Key identifier.

. This attribute was added in vSphere API 7.0.0.

-.key_server key_server_info Key server associated with this provider. This attribute was added in vSphere API 7.0.0.

-.key_server.type string Type of the key server. This attribute was added in vSphere API 7.0.0.

List the key server types. This enumeration was added in vSphere API 7.0.0. Value is one of:
KMIP: Key Management Interoperability Protocol (KMIP) based key management server. This constant was added in vSphere API 7.0.0.

-.key_server.description string Description of the key server. This attribute was added in vSphere API 7.0.0.

-.key_server.proxy_server.hostname string The IP address or DNS resolvable name of the service. This attribute was added in vSphere API 7.0.0.

-.key_server.kmip_server.servers server[] List of KMIP compliant key servers. This attribute was added in vSphere API 7.0.0.

-.key_server.kmip_server.servers[].name string Name of the server.

A unique string chosen by the client.

. This attribute was added in vSphere API 7.0.0.

-.key_server.kmip_server.servers[].address network_address The server's address. This attribute was added in vSphere API 7.0.0.

-.key_server.kmip_server.servers[].address.hostname string The IP address or DNS resolvable name of the service. This attribute was added in vSphere API 7.0.0.

-.status status Status of the provider in the cluster. This attribute was added in vSphere API 7.0.0.

-.status.health string The health of the provider. This attribute was added in vSphere API 7.0.0.

Defines the possible health states. This enumeration was added in vSphere API 7.0.0. Value is one of:
NONE: No status available. This constant was added in vSphere API 7.0.0.
OK: Health is normal. This constant was added in vSphere API 7.0.0.
WARNING: Health is normal, however there is an issue that requires attention. This constant was added in vSphere API 7.0.0.
ERROR: Not healthy. This constant was added in vSphere API 7.0.0.

-.status.details localizable_message[] Details regarding the health of the provider.

When the service health is not OK, this field will provide an actionable description of the issue.

. This attribute was added in vSphere API 7.0.0.

-.status.servers server_info[] Health of the key servers. This attribute was added in vSphere API 7.0.0.

Optional
-.key_server.proxy_server network_address Proxy server configuration.

. This attribute was added in vSphere API 7.0.0.

Optional. If unset, proxy server configuration will not be set.

-.key_server.proxy_server.port long The port of the service. This attribute was added in vSphere API 7.0.0.

Optional. If unset, port 443 will be used.

-.key_server.connection_timeout long Connection timeout in seconds.

. This attribute was added in vSphere API 7.0.0.

Optional. If unset, connection timeout will be unset.

-.key_server.kmip_server kmip_server_info Configuration information for KMIP based key server. This attribute was added in vSphere API 7.0.0.

Optional. It is only relevant when type has value KMIP. This field is optional and it is only relevant when the value of type is KMIP.

-.key_server.kmip_server.servers[].address.port long The port of the service. This attribute was added in vSphere API 7.0.0.

Optional. If unset, port 443 will be used.

-.key_server.kmip_server.username string Username for authentication.

. This attribute was added in vSphere API 7.0.0.

Optional. If unset, username will not be set.