इवेंट हैंडलर का उपयोग करना¶
आप SolusVM 2 में ईवेंट हैंडलर का उपयोग कर सकते हैं ताकि विशिष्ट ईवेंट घटित होने पर कुछ क्रियाएं स्वचालित रूप से हो सकें। फिलहाल, वेबहुक ही एकमात्र समर्थित इवेंट हैंडलर प्रकार है। भविष्य में अन्य इवेंट हैंडलर प्रकार जोड़े जा सकते हैं।
ईवेंट हैंडलर बनाते समय, आप समर्थित ईवेंट की सूची से एक या अधिक ईवेंट चुन सकते हैं, जैसे आईपी पता जोड़ना या सर्वर हटाना। आप केवल समर्थित ईवेंट के लिए ईवेंट हैंडलर बना सकते हैं। हर बार जब कोई समर्थित ईवेंट होता है, चाहे वह किसी व्यवस्थापक या ग्राहक द्वारा शुरू किया गया हो, उस ईवेंट से जुड़े सभी ईवेंट हैंडलर ट्रिगर हो जाते हैं।
एक वेबहुक बनाना¶
वेबहुक एक उपयोगकर्ता-परिभाषित HTTP/HTTPS कॉलबैक है। हर बार जब इस प्रकार का ईवेंट हैंडलर ट्रिगर होता है, तो यह वेबहुक निष्पादित करता है, और फिर SolusVM 2 वेबहुक URL पर एक POST अनुरोध भेजता है। SolusVM 2 अधिकतम पांच रीडायरेक्ट का अनुसरण करता है, और वेबसाइट के एसएसएल/टीएलएस प्रमाणपत्र (यदि कोई हो) की वैधता की जांच नहीं करता है। कई पूर्व निर्धारित पैरामीटर हमेशा URL के माध्यम से पारित किए जाते हैं (उदाहरण के लिए, सर्वर की आईडी हटाई जा रही है, या आईपी पता जोड़ा जा रहा है)। उपयोगकर्ता द्वारा परिभाषित अतिरिक्त मापदंडों को पारित करने के लिए एक वेबहुक को भी कॉन्फ़िगर किया जा सकता है।
हर बार जब कोई वेबहुक ट्रिगर होता है, तो SolusVM 2 में एक कार्य बनाया जाता है। यदि स्क्रिप्ट 4хх या 5хх HTTP स्थिति कोड लौटाती है तो कार्य में "विफल" स्थिति होगी।
वेबहुक बनाने के लिए:
- SolusVM 2 में लॉग इन करें।
- सेटिंग्स > इवेंट हैंडलर पर जाएं, और फिर वेबहुक जोड़ें पर क्लिक करें।
- अपने वेबहुक को एक अनोखा नाम दें.
- वेबहुक यूआरएल निर्दिष्ट करें. हर बार वेबहुक ट्रिगर होने पर इस यूआरएल पर एक अनुरोध भेजा जाएगा।
- ड्रॉप-डाउन मेनू से एक या अधिक ईवेंट चुनें. हर बार जब कोई समर्थित ईवेंट होता है, तो वेबहुक चालू हो जाएगा।
- (वैकल्पिक) वेबहुक यूआरएल के माध्यम से पारित किए जाने वाले अतिरिक्त अनुरोध पैरामीटर निर्दिष्ट करें। पैरामीटर JSON प्रारूप में होने चाहिए.
- (वैकल्पिक) यदि आप चाहते हैं कि वेबहुक निर्माण के बाद सक्रिय हो जाए तो "सक्षम" चेकबॉक्स चुनें। वैकल्पिक रूप से, आप बाद में वेबहुक को सक्षम कर सकते हैं।
- सहेजें पर क्लिक करें।
वेबहुक बनाया गया है. आप इसे सेटिंग्स > इवेंट हैंडलर में पा सकते हैं। यदि आपने निर्माण के दौरान वेबहुक को सक्षम किया है, तो अगली बार जब कोई समर्थित घटना होगी, तो वेबहुक ट्रिगर हो जाएगा, और वेबहुक यूआरएल पर एक अनुरोध भेजा जाएगा।
वेबहुक को संशोधित करना, अक्षम करना और हटाना¶
वेबहुक को संशोधित करने के लिए:
- SolusVM 2 में लॉग इन करें।
- सेटिंग्स > इवेंट हैंडलर पर जाएं।
- जिस वेबहुक को आप संशोधित करना चाहते हैं, उसके अनुरूप
आइकन पर क्लिक करें।
- वांछित परिवर्तन करें और फिर सहेजें पर क्लिक करें।
परिवर्तन अब प्रभावी हैं.
वेबहुक को सक्षम या अक्षम करने के लिए:
- SolusVM 2 में लॉग इन करें।
- सेटिंग्स > इवेंट हैंडलर पर जाएं।
- जिस वेबहुक को आप सक्षम या अक्षम करना चाहते हैं, उसके अनुरूप टॉगल बटन पर क्लिक करें ताकि वह "सक्षम" (नीला) या "अक्षम" (ग्रे) दिखाए।
वेबहुक अब सक्षम (या अक्षम) है।
वेबहुक हटाने के लिए:
- SolusVM 2 में लॉग इन करें।
- सेटिंग्स > इवेंट हैंडलर पर जाएं।
- जिस वेबहुक को आप हटाना चाहते हैं उसके अनुरूप
आइकन पर क्लिक करें और फिर हटाएं पर क्लिक करें।
वेबहुक हटा दिया गया है.
वेबहुक द्वारा पारित पैरामीटरों की सूची¶
हर बार जब कोई वेबहुक ट्रिगर होता है, तो यह यूआरएल के माध्यम से निम्नलिखित पैरामीटर पास करता है:
crId
crHostname
crStatus
(commissioning, configure_network, active, failed, unavailable)crLicenseType
(micro, mini, standard)serverId
serverIps
(उदाहरण के लिए, ["10.0.0.1", "10.0.0.2"])serverHostname
serverUuid
serverStatus
(मौजूद नहीं, प्रारंभ, बंद, अनुपलब्ध)userId
billingUserId
userEmail
userStatus
(सक्रिय, लॉक, निलंबित)userAllowedIps
(उदाहरण के लिए, ["10.0.0.1", "10.0.0.2"])
वेबहुक उदाहरण¶
आप एक वेबहुक बना सकते हैं जो WHMCS में एक कंप्यूट संसाधन से दूसरे में माइग्रेट किए गए सर्वर के आईपी पते को स्वचालित रूप से अपडेट कर देगा।
वेबहुक बनाने के लिए:
-
SSH के माध्यम से अपने WHMCS सर्वर में लॉग इन करें।
-
SolusVM 2 WHMCS ऐडऑन के साथ भेजी गई
hook_example.php
फ़ाइल का पता लगाएँ। फ़ाइलmodules/servers/solusvm2vps/
निर्देशिका में होनी चाहिए। -
फ़ाइल की एक प्रतिलिपि बनाएँ, और फिर प्रतिलिपि का संपादन प्रारंभ करें।
-
पंक्ति 6 पर
exit();
को हटाएँ। -
अपने रहस्यों को
$securitySecrets
वेरिएबल में जोड़ें। -
अपने SolusVM 2 प्रबंधन नोड के आईपी पते को
$connectionIPs
वेरिएबल में जोड़ें। -
परिवर्तनों को सुरक्षित करें।
-
SolusVM 2 में लॉग इन करें।
-
सेटिंग्स > इवेंट हैंडलर पर जाएं, और फिर वेबहुक जोड़ें पर क्लिक करें।
-
अपने वेबहुक को एक अनोखा नाम दें.
-
संपादित स्क्रिप्ट का URL निर्दिष्ट करें.
-
ड्रॉप-डाउन मेनू से "अतिरिक्त आईपी जोड़ें या हटाएं" चुनें।
-
इस प्रक्रिया के चरण 5 के दौरान आपके द्वारा स्क्रिप्ट में जोड़े गए रहस्य निर्दिष्ट करें:
{ "secret": "<your secret goes here>" }
-
"सक्षम" चेकबॉक्स चुनें और फिर सहेजें पर क्लिक करें।
अब, हर बार जब कोई सर्वर माइग्रेट होता है, तो WHMCS में सर्वर के आईपी पते को अपडेट करने का कार्य SolusVM 2 में बनाया जाएगा।