def ldap_group_map_locale_remove(handle, ldap_group_map_name, name): """ removes locale from the respective ldap group map Args: handle (UcscHandle) ldap_group_map_name (string): name of ldap group name (string): locale name Returns: None Raises: UcscOperationError: If AaaUserLocale is not present Example: ldap_group_map_locale_remove(handle, ldap_group_map_name="test_ldap_grp_map", name="locale1") """ mo = ldap_group_map_locale_get(handle, ldap_group_map_name, name) if not mo: raise UcscOperationError("ldap_group_map_locale_remove", "Ldap Group Locale does not exist") if not locale_get(handle, name=name)[0]: raise UcscOperationError("ldap_group_map_locale_remove", "Locale '%s' does not exist" % name) handle.remove_mo(mo) handle.commit()
def ldap_provider_group_provider_add(handle, group_name, name, order="lowest-available", descr=None, **kwargs): """ adds provider to ldap provider group Args: handle (UcscHandle) group_name (string): ldap provider group name name (string): name order (string): order descr (string): descr **kwargs: Any additional key-value pair of managed object(MO)'s property and value, which are not part of regular args. This should be used for future version compatibility. Returns: AaaProviderRef : Managed Object Raises: UcscOperationError: If AaaProviderGroup or AaaProvider is not present Example: ldap_provider_group_provider_add(handle, group_name="test_ldap_provider_group", name="test_provider", order="1") """ from ucscsdk.mometa.aaa.AaaProviderRef import AaaProviderRef group_dn = ucsc_base_dn + "/ldap-ext/providergroup-" + group_name group_mo = handle.query_dn(group_dn) if not group_mo: raise UcscOperationError("ldap_provider_group_provider_add", "Ldap Provider Group does not exist.") provider_dn = ucsc_base_dn + "/ldap-ext/provider-" + name provider_mo = handle.query_dn(provider_dn) if not provider_mo: raise UcscOperationError("ldap_provider_group_provider_add", "Ldap Provider does not exist.") mo = AaaProviderRef(parent_mo_or_dn=group_mo, name=name, order=order, descr=descr) mo.set_prop_multiple(**kwargs) handle.add_mo(mo, True) handle.commit() return mo
def dns_server_remove(handle, name): """ Removes a dns server Args: handle (UcscHandle) name (string): IP Address of the dns server Returns: None Raises: UcscOperationError: If CommDnsProvider is not present Example: dns_server_remove(handle, "10.10.10.10") """ mo = dns_server_get(handle, name) if not mo: raise UcscOperationError("dns_server_remove", "dns server '%s' not found" % name) handle.remove_mo(mo) handle.commit()
def user_locale_remove(handle, user_name, name): """ Remove locale from user Args: handle (UcscHandle) user_name (string): username name (string): locale name Returns: None Raises: UcscOperationError: If AaaUserLocale is not present Example: user_locale_remove(handle, user_name="test", name="testlocale") """ mo = user_locale_get(handle, user_name, name) if not mo: raise UcscOperationError("user_locale_remove", "Locale is not associated with user.") handle.remove_mo(mo) handle.commit()
def user_modify(handle, name, **kwargs): """ modifies user Args: handle (UcscHandle) name (string): name **kwargs: key-value pair of managed object(MO) property and value, Use 'print(ucsccoreutils.get_meta_info(<classid>).config_props)' to get all configurable properties of class Returns: AaaUser: Managed Object Raises: UcscOperationError: If AaaUser is not present Example: user_modify(handle, name="test", first_name="firstname", last_name="lastname", descr=None, clear_pwd_history="no", phone="+91-1234567890", email="*****@*****.**", expires="yes", pwd_life_time="no-password-expire", expiration="2016-01-13T00:00:00", enc_pwd=None, account_status="active") """ mo = user_get(handle, name) if not mo: raise UcscOperationError("user_modify", "User does not exist.") mo.set_prop_multiple(**kwargs) handle.set_mo(mo) handle.commit() return mo
def trusted_point_modify(handle, name, **kwargs): """ Modifies a trusted point Args: handle (ucschandle) name (string): name **kwargs: key-value pair of managed object(MO) property and value, Use 'print(ucsccoreutils.get_meta_info(<classid>).config_props)' to get all configurable properties of class Returns: PkiTP object Raises: UcscOperationError: if PkiTP not present Example: trusted_point = trusted_point_modify(handle, name="test_tp", descr="testing tp") """ mo = trusted_point_get(handle, name) if not mo: raise UcscOperationError("trusted_point_modify", "trusted point '%s' does not exist" % name) mo.set_prop_multiple(**kwargs) handle.set_mo(mo) handle.commit() return mo
def key_ring_delete(handle, name): """ Deletes a key ring Args: handle (UcscHandle) name (string): name Returns: none Raises: UcscOperationError: if pkikeyring mo is not present Example: key_ring_delete(handle, name="mykeyring") """ mo = key_ring_get(handle, name) if not mo: raise UcscOperationError("key_ring_delete", "keyring '%s' does not exist" % name) handle.remove_mo(mo) handle.commit()
def ntp_server_remove(handle, name): """ Removes the NTP server. Args: handle (UcscHandle) name : NTP server IP address or Name Returns: None Raises: UcscOperationError: If CommNtpProvider is not found Example: ntp_server_remove(handle, "72.163.128.140") """ mo = ntp_server_get(handle, name) if not mo: raise UcscOperationError("ntp_server_remove", "NTP Server not found. Nothing to remove.") handle.remove_mo(mo) handle.commit()
def radius_provider_modify(handle, name, **kwargs): """ modifies a radius provider Args: handle (UcscHandle) name (string): name **kwargs: key-value pair of managed object(MO) property and value, Use 'print(ucsccoreutils.get_meta_info(<classid>).config_props)' to get all configurable properties of class Returns: AaaRadiusProvider: Managed Object Raises: UcscOperationError: If AaaRadiusProvider is not present Example: radius_provider_modify(handle, name="test_radius_prov", timeout="5") """ mo = radius_provider_get(handle, name) if not mo: raise UcscOperationError("radius_provider_modify", "Radius Provider does not exist %s" % name) mo.set_prop_multiple(**kwargs) handle.set_mo(mo) handle.commit() return mo
def call_home_disable(handle): """ Disables call home alert. Args: handle (UcscHandle) Returns: CallhomeEp : ManagedObject Raises: UcscOperationError: If CallhomeEp is not present Example: call_home_state_disable(handle) """ mo = handle.query_dn(ucsc_base_dn + "/call-home") if not mo: raise UcscOperationError("call_home_disable", "Call home not available.") mo.admin_state = "off" handle.set_mo(mo) handle.commit() return mo
def role_delete(handle, name): """ deletes role Args: handle (UcscHandle) name (string): role name Returns: None Raises: UcscOperationError: If AaaRole is not present Example: role_delete(handle, name="test_role") """ mo = role_get(handle, name) if mo is None: raise UcscOperationError("role_delete", "Role does not exist") handle.remove_mo(mo) handle.commit()
def call_home_proxy_config(handle, url, port="80", **kwargs): """ Configures HTTP proxy for callhome Args: handle (UcscHandle) url (String) : URL for the call home proxy port (String) : port number for the call home proxy **kwargs: Any additional key-value pair of managed object(MO)'s property and value, which are not part of regular args. This should be used for future version compatibility. Returns: SmartcallhomeHttpProxy : ManagedObject Raises: UcscOperationError: If SmartcallhomeHttpProxy is not present Example: call_home_proxy_config(handle, url="www.testproxy.com", port=80) """ mo = handle.query_dn(ucsc_base_dn + "/call-home/proxy") if not mo: raise UcscOperationError("call_home_proxy_config", "call home proxy is not available.") mo.url = url mo.port = port mo.set_prop_multiple(**kwargs) handle.add_mo(mo, modify_present=True) handle.commit() return mo
def auth_domain_delete(handle, name): """ deletes a auth domain. Args: handle (UcscHandle) name (string): auth domain name Returns: None Raises: UcscOperationError: If AaaDomain is not present Example: auth_domain_delete(handle, name="test_auth_dom") """ mo = auth_domain_get(handle, name) if not mo: raise UcscOperationError("auth_domain_delete", "Auth Domain '%s' does not exist." % name) handle.remove_mo(mo) handle.commit()
def auth_domain_modify(handle, name, **kwargs): """ Modifies a domain Args: handle (UcscHandle) name (string): name of domain **kwargs: key-value pair of managed object(MO) property and value, Use 'print(ucsccoreutils.get_meta_info(<classid>).config_props)' to get all configurable properties of class Returns: AaaDomain : Managed Object Raises: UcscOperationError: If AaaDomain is not present Example: auth_domain_modify(handle, name="test_auth_dom", session_timeout="1000") """ mo = auth_domain_get(handle, name) if not mo: raise UcscOperationError("auth_domain_modify", "Auth Domain '%s' does not exist." % name) mo.set_prop_multiple(**kwargs) handle.set_mo(mo) handle.commit() return mo
def ldap_provider_group_provider_modify(handle, group_name, name, **kwargs): """ modify provider of ldap provider group Args: handle (UcscHandle) group_name (string): ldap provider group name name (string): name **kwargs: key-value pair of managed object(MO) property and value, Use 'print(ucsccoreutils.get_meta_info(<classid>).config_props)' to get all configurable properties of class Returns: True/False Raises: AaaProviderRef : Managed Object Example: ldap_provider_group_provider_modify(handle, group_name="test_ldap_provider_group", name="test_provider", order="1") """ mo = ldap_provider_group_provider_get(handle, group_name, name) if not mo: raise UcscOperationError("ldap_provider_group_provider_modify", "Provider not available under group.") mo.set_prop_multiple(**kwargs) handle.set_mo(mo) handle.commit() return mo
def locale_domaingroup_unassign(handle, locale_name, name): """ unassigns a locale Args: handle (UcscHandle) locale_name(string): locale name name (string): name of assignment descr (string): descr Returns: None Raises: UcscOperationError: If AaaOrg is not present Example: locale_domaingroup_unassign(handle, locale_name="test_locale, name="test_domgrp_asn") """ locale_dn = ucsc_base_dn + "/locale-" + locale_name dn = locale_dn + "/domaingroup-" + name mo = handle.query_dn(dn) if not mo: raise UcscOperationError("locale_domaingroup_unassign", "No domaingroup assigned to Locale") handle.remove_mo(mo) handle.commit()
def locale_modify(handle, name, **kwargs): """ modifies a locale Args: handle (UcscHandle) name (string): name of locale **kwargs: key-value pair of managed object(MO) property and value, Use 'print(ucsccoreutils.get_meta_info(<classid>).config_props)' to get all configurable properties of class Returns: AaaLocale : Managed Object Raises: UcscOperationError: If AaaLocale is not present Example: locale_modify(handle, name="test_locale", descr="testing locale") """ mo = locale_get(handle, name) if not mo: raise UcscOperationError("locale_modify", "Locale does not exist") mo.set_prop_multiple(**kwargs) handle.set_mo(mo) handle.commit() return mo
def radius_provider_group_delete(handle, name): """ deletes a radius provider group Args: handle (UcscHandle) name (string): name Returns: None Raises: UcscOperationError: If AaaProviderGroup is not present Example: radius_provider_group_delete(handle, name="test_prov_grp") """ mo = radius_provider_group_get(handle, name) if not mo: raise UcscOperationError("radius_provider_group_delete", "Provider Group does not exist.") handle.remove_mo(mo) handle.commit()
def key_ring_modify(handle, name, **kwargs): """ Modifies a key ring Args: handle (UcscHandle) name (string): name **kwargs: key-value pair of managed object(MO) property and value, Use 'print(ucsccoreutils.get_meta_info(<classid>).config_props)' to get all configurable properties of class Returns: PkiKeyRing : Managed object Raises: UcscOperationError: if PkiKeyRing is not present Example: key_ring = key_ring_modify(handle, name="test_kr", regen="no") """ mo = key_ring_get(handle, name) if not mo: raise UcscOperationError("key_ring_modify", "keyring '%s' does not exist" % name) mo.set_prop_multiple(**kwargs) handle.set_mo(mo) handle.commit() return mo
def radius_provider_group_provider_get(handle, group_name, name): """ Gets provider under a radius provider group Args: handle (UcscHandle) group_name (string): group_name name (string): name Returns: AaaProviderRef: Managed Object OR None Raises: UcscOperationError: If AaaProviderGroup or AaaProvider is not present Example: radius_provider_group_provider_get(handle, group_name="test_radius_provider_group", name="test_radius_provider") """ group_dn = ucsc_base_dn + "/radius-ext/providergroup-" + group_name group_mo = handle.query_dn(group_dn) if not group_mo: raise UcscOperationError("radius_provider_group_provider_get", "Radius Provider Group does not exist.") provider_dn = group_dn + "/provider-ref-" + name return handle.query_dn(provider_dn)
def certificate_request_remove(handle, name): """ Removes a certificate request from keyring Args: handle (UcscHandle) name (string): KeyRing name Returns: None Raises: UcscOperationError: If PkiCertReq is not present Example: key_ring = key_ring_create(handle, name="mykeyring") certificate_request_remove(handle, key_ring=key_ring) """ mo = certificate_request_get(handle, name) if not mo: raise UcscOperationError( "certificate_request_remove", "keyring certificate '%s' does not exist" % name) handle.remove_mo(mo) handle.commit()
def radius_provider_group_modify_provider(handle, group_name, name, **kwargs): """ modifies a provider to a radius provider group Args: handle (UcscHandle) group_name (string): group_name name (string): name **kwargs: key-value pair of managed object(MO) property and value, Use 'print(ucsccoreutils.get_meta_info(<classid>).config_props)' to get all configurable properties of class Returns: AaaProviderRef: Managed Object Raises: UcscOperationError: If AaaProviderRef is not present Example: radius_provider_group_modify_provider( handle, group_name="test_prov_grp", name="test_radius_prov", order="2") """ mo = radius_provider_group_provider_get(handle, group_name, name) if not mo: raise UcscOperationError("radius_provider_group_modify_provider", "Provider not available under group.") mo.set_prop_multiple(**kwargs) handle.set_mo(mo) handle.commit() return mo
def trusted_point_delete(handle, name): """ Deletes a truted point Args: handle (ucschandle) name (string): name Returns: None Raises: UcscOperationError: if PkiTP mo is not present Example: trusted_point_delete(handle, name="mytrustedpoint") """ mo = trusted_point_get(handle, name) if not mo: raise UcscOperationError("trusted_point_delete", "trust point '%s' does not exist" % name) handle.remove_mo(mo) handle.commit()
def radius_provider_group_remove_provider(handle, group_name, name): """ removes a provider from a radius provider group Args: handle (UcscHandle) group_name (string): group_name name (string): name Returns: None Raises: UcscOperationError: If AaaProviderRef is not present Example: radius_provider_group_remove_provider(handle, group_name="test_radius_provider_group", name="test_radius_provider") """ mo = radius_provider_group_provider_get(handle, group_name, name) if not mo: raise UcscOperationError("radius_provider_group_remove_provider", "Provider not available under group.") handle.remove_mo(mo) handle.commit()
def user_delete(handle, name): """ deletes user Args: handle (UcscHandle) name (string): name Returns: None Raises: UcscOperationError: If AaaUser is not present Example: user_delete(handle, name="test") """ mo = user_get(handle, name) if not mo: raise UcscOperationError("user_delete", "User does not exist.") handle.remove_mo(mo) handle.commit()
def lan_conn_policy_create(handle, name, descr=None, parent_dn="org-root", **kwargs): """ Creates LAN Connectivity Policy Args: handle (UcscHandle) name (string) : LAN Connectivity Policy name descr (string): description parent_dn (string) : Dn of org **kwargs: Any additional key-value pair of managed object(MO)'s property and value, which are not part of regular args. This should be used for future version compatibility. Returns: VnicLanConnPolicy: Managed Object Example: lan_conn_policy_create(handle, "samp_conn_pol2") """ from ucscsdk.mometa.vnic.VnicLanConnPolicy import VnicLanConnPolicy obj = handle.query_dn(parent_dn) if not obj: raise UcscOperationError("lan_conn_policy_create", "Org %s does not exist" % parent_dn) mo = VnicLanConnPolicy(parent_mo_or_dn=obj, name=name, descr=descr) mo.set_prop_multiple(**kwargs) handle.add_mo(mo, modify_present=True) handle.commit() return mo
def dns_set_domain_name(handle, domain, **kwargs): """ Sets the Ucs Central domain name for dns Args: handle (UcscHandle) domain (string): Domain name **kwargs: Any additional key-value pair of managed object(MO)'s property and value, which are not part of regular args. This should be used for future version compatibility. Returns: CommDns : Managed Object Raises: UcscOperationError: If CommDns is not present Example: dns_set_domain_name(handle, domain="cisco.com") """ dn = ucsc_base_dn + "/dns-svc" mo = handle.query_dn(dn) if not mo: raise UcscOperationError("dns_set_domain_name", "dns MO doesn't exist") mo.domain = domain mo.set_prop_multiple(**kwargs) handle.set_mo(mo) handle.commit() return mo
def locale_delete(handle, name): """ deletes locale Args: handle (UcscHandle) name (string): locale name Returns: None Raises: UcscOperationError: If AaaLocale is not present Example: locale_delete(handle, name="test_locale") """ mo = locale_get(handle, name) if not mo: raise UcscOperationError("locale_delete", "Locale does not exist") handle.remove_mo(mo) handle.commit()
def ip_pool_create(handle, name, descr=None, parent_dn="org-root", **kwargs): """ Creates IP Pool Args: handle (UcscHandle) name (string) : IP pool name descr (string): description parent_dn (string) : Dn of org **kwargs: Any additional key-value pair of managed object(MO)'s property and value, which are not part of regular args. This should be used for future version compatibility. Returns: IppoolPool : Managed Object Example: ip_pool_create(handle, "sample_ip_pool", descr="default") """ from ucscsdk.mometa.ippool.IppoolPool import IppoolPool obj = handle.query_dn(parent_dn) if not obj: raise UcscOperationError("ip_pool_create", "Org %s does not exist" % parent_dn) mo = IppoolPool(parent_mo_or_dn=obj, descr=descr, name=name) mo.set_prop_multiple(**kwargs) handle.add_mo(mo, True) handle.commit() return mo
def locale_org_unassign(handle, locale_name, name): """ unassigns a locale from org Args: handle (UcscHandle) locale_name(string): locale name name (string): name of assignment Returns: None Raises: UcscOperationError: If AaaOrg is not present Example: locale_org_unassign(handle, locale_name="test_locale, name="org_name") """ locale_dn = ucsc_base_dn + "/locale-" + locale_name dn = locale_dn + "/org-" + name mo = handle.query_dn(dn) if not mo: raise UcscOperationError("locale_org_unassign", "No Org assigned to Locale") handle.remove_mo(mo) handle.commit()